Merge remote-tracking branch 'origin/v0.8.0' into datamodel-v1.0

src/ifcopenshell-python/ifcopenshell/__init__.py

@@ -53,14 +53,16 @@ Example:
     for wall in walls:
         print(wall.Name)
 """
+
 from __future__ import annotations
+
 import os
 import sys
-import zipfile
 import tempfile
-from pathlib import Path
-from typing import Optional, Union, TYPE_CHECKING, Any, overload, Literal
+import zipfile
 from collections.abc import Generator, Sequence
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, Literal, Optional, Union, overload
 
 if TYPE_CHECKING:
     import ifcopenshell.express.schema_class
@@ -88,12 +90,10 @@ except Exception:
 
 # `_file`, `_stream` is used only for annotations inside this file,
 # see https://github.com/microsoft/pyright/discussions/9065.
-from .ifcopenshell_wrapper import file as _file
-from .ifcopenshell_wrapper import file
-
-from .file import rocksdb_lazy_instance
 from . import guid
-from .ifcopenshell_wrapper import entity_instance
+from .entity_instance import entity_instance
+from .file import file, rocksdb_lazy_instance
+from .file import file as _file
 from .sql import sqlite, sqlite_entity
 
 # explicitly specify available imported symbols
@@ -103,6 +103,7 @@ __all__ = [
     "file",
     "guid",
     "ifcopenshell_wrapper",
+    "rocksdb_lazy_instance",
     "sqlite",
     "sqlite_entity",
     "stream",
@@ -110,8 +111,8 @@ __all__ = [
 ]
 
 try:
-    from .stream import stream as _stream, stream_entity
-    from .stream import stream
+    from .stream import stream, stream_entity  # ty: ignore[possibly-missing-import]
+    from .stream import stream as _stream  # ty: ignore[possibly-missing-import]
 except:
     pass
 
@@ -130,17 +131,21 @@ class SchemaError(Error):
 
 @overload
 def open(
-    path: Union[os.PathLike, str], format: Optional[str] = None, *, should_stream: Literal[False] = False
+    path: Union[os.PathLike, str], format: SupportedFormat = None, *, should_stream: Literal[False] = False
 ) -> Union[_file, sqlite]: ...
 @overload
-def open(path: Union[os.PathLike, str], format: Optional[str] = None, *, should_stream: Literal[True]) -> _stream: ...
+def open(path: Union[os.PathLike, str], format: SupportedFormat = None, *, should_stream: Literal[True]) -> _stream: ...
 @overload
 def open(
-    path: Union[os.PathLike, str], format: Optional[str] = None, *, should_stream: bool = False, readonly: bool = False
+    path: Union[os.PathLike, str],
+    format: SupportedFormat = None,
+    *,
+    should_stream: bool = False,
+    readonly: bool = False,
 ) -> Union[_file, sqlite, _stream]: ...
 def open(
     path: Union[os.PathLike, str],
-    format: Optional[str] = None,
+    format: SupportedFormat = None,
     should_stream: bool = False,
     readonly: bool = False,
     mmap: bool = False,
@@ -152,8 +157,7 @@ def open(
         for reading large files.
 
     You can specify a file format. If no format is given, it is guessed from
-    its extension. Currently supported specified format: .ifc | .ifcZIP |
-    .ifcXML.
+    its extension.
 
     You can then filter by element ID, class, etc, and subscript by id or guid.
 
@@ -199,11 +203,13 @@ def open(
         for ty in bypass_types:
             f.bypass_type(ty)
         if mmap:
-            f.initialize(str(path.absolute()), mmap=mmap)
+            # mmap parameter is only available for builds with USE_MMAP, not used in our main builds
+            f.initialize(str(path.absolute()), mmap=mmap)  # ty: ignore[unknown-argument]
         else:
             f.initialize(str(path.absolute()))
     elif mmap:
-        f = ifcopenshell_wrapper.open(str(path.absolute()), mmap=mmap)
+        # mmap parameter is only available for builds with USE_MMAP, not used in our main builds
+        f = ifcopenshell_wrapper.open(str(path.absolute()), mmap=mmap)  # ty: ignore[unknown-argument]
     else:
         f = ifcopenshell_wrapper.open(str(path.absolute()))
 
@@ -284,7 +290,10 @@ def schema_by_name(
     return ifcopenshell_wrapper.schema_by_name(schema)
 
 
-def guess_format(path: Path) -> Literal[".ifc", ".ifcZIP", ".ifcXML", ".ifcJSON", ".ifcSQLite", None]:
+SupportedFormat = Literal[".ifc", ".ifcZIP", ".ifcXML", ".ifcJSON", ".ifcSQLite", "rocksdb", None]
+
+
+def guess_format(path: Path) -> SupportedFormat:
     """Guesses the IFC format using file extension
 
     IFCs may be serialised as different formats. The most common is a ``.ifc``