typing

Author: Andrej730

src/ifcopenshell-python/ifcopenshell/api/layer/add_layer.py

@@ -15,9 +15,11 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
+from typing import Optional
 
 
-def add_layer(file, Name=None) -> None:
+def add_layer(file: ifcopenshell.file, Name: Optional[str] = None) -> ifcopenshell.entity_instance:
     """Adds a new layer
 
     An IFC layer is like a CAD layer. Portions of an object's geometry
@@ -41,6 +43,4 @@ def add_layer(file, Name=None) -> None:
 
         ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL-FULL-DIMS-N")
     """
-    settings = {"Name": Name or "Unnamed"}
-
-    return file.create_entity("IfcPresentationLayerAssignment", Name=settings["Name"])
+    return file.create_entity("IfcPresentationLayerAssignment", Name=Name)

src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py

@@ -15,9 +15,11 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
+from typing import Any
 
 
-def edit_layer(file, layer=None, attributes=None) -> None:
+def edit_layer(file: ifcopenshell.file, layer: ifcopenshell.entity_instance, attributes: dict[str, Any]) -> None:
     """Edits the attributes of an IfcPresentationLayerAssignment
 
     For more information about the attributes and data types of an
@@ -26,7 +28,7 @@ def edit_layer(file, layer=None, attributes=None) -> None:
     :param layer: The IfcPresentationLayerAssignment entity you want to edit
     :type layer: ifcopenshell.entity_instance
     :param attributes: a dictionary of attribute names and values.
-    :type attributes: dict, optional
+    :type attributes: dict
     :return: None
     :rtype: None
 
@@ -38,7 +40,7 @@ def edit_layer(file, layer=None, attributes=None) -> None:
         ifcopenshell.api.run("layer.edit_layer", model,
             layer=layer, attributes={"Description": "All walls, based on the AIA standard."})
     """
-    settings = {"layer": layer, "attributes": attributes or {}}
+    settings = {"layer": layer, "attributes": attributes}
 
     for name, value in settings["attributes"].items():
         setattr(settings["layer"], name, value)

src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py

@@ -15,9 +15,10 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
 
 
-def remove_layer(file, layer=None) -> None:
+def remove_layer(file: ifcopenshell.file, layer: ifcopenshell.entity_instance) -> None:
     """Removes a layer
 
     All representation items assigned to the layer will remain, but the
@@ -35,6 +36,4 @@ def remove_layer(file, layer=None) -> None:
         layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
         ifcopenshell.api.run("layer.remove_layer", model, layer=layer)
     """
-    settings = {"layer": layer}
-
-    file.remove(settings["layer"])
+    file.remove(layer)

src/ifcopenshell-python/ifcopenshell/api/library/add_library.py

@@ -21,7 +21,7 @@
 import ifcopenshell.util.date
 
 
-def add_library(file, name=None) -> None:
+def add_library(file: ifcopenshell.entity_instance, name: str) -> ifcopenshell.entity_instance:
     """Adds a new library to the project
 
     A library is an external data source that is related to the project. It
@@ -60,6 +60,4 @@ def add_library(file, name=None) -> None:
 
         ifcopenshell.api.run("library.add_library", model, name="Brickschema")
     """
-    settings = {"name": name}
-
-    return file.create_entity("IfcLibraryInformation", Name=settings["name"])
+    return file.create_entity("IfcLibraryInformation", Name=name)

src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py

@@ -15,9 +15,11 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
+from typing import Any
 
 
-def edit_library(file, library=None, attributes=None) -> None:
+def edit_library(file: ifcopenshell.file, library: ifcopenshell.entity_instance, attributes: dict[str, Any]) -> None:
     """Edits the attributes of an IfcLibraryInformation
 
     For more information about the attributes and data types of an
@@ -26,7 +28,7 @@ def edit_library(file, library=None, attributes=None) -> None:
     :param library: The IfcLibraryInformation entity you want to edit
     :type library: ifcopenshell.entity_instance
     :param attributes: a dictionary of attribute names and values.
-    :type attributes: dict, optional
+    :type attributes: dict
     :return: None
     :rtype: None
 
@@ -39,7 +41,7 @@ def edit_library(file, library=None, attributes=None) -> None:
             attributes={"Description": "A Brickschema TTL including only mechanical distribution systems."})
     """
 
-    settings = {"library": library, "attributes": attributes or {}}
+    settings = {"library": library, "attributes": attributes}
 
     for name, value in settings["attributes"].items():
         setattr(settings["library"], name, value)

src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py

@@ -15,9 +15,13 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
+from typing import Any
 
 
-def edit_reference(file, reference=None, attributes=None) -> None:
+def edit_reference(
+    file: ifcopenshell.file, reference: ifcopenshell.entity_instance, attributes: dict[str, Any]
+) -> None:
     """Edits the attributes of an IfcLibraryReference
 
     For more information about the attributes and data types of an
@@ -26,7 +30,7 @@ def edit_reference(file, reference=None, attributes=None) -> None:
     :param reference: The IfcLibraryReference entity you want to edit
     :type reference: ifcopenshell.entity_instance
     :param attributes: a dictionary of attribute names and values.
-    :type attributes: dict, optional
+    :type attributes: dict
     :return: None
     :rtype: None
 
@@ -40,7 +44,7 @@ def edit_reference(file, reference=None, attributes=None) -> None:
         ifcopenshell.api.run("library.edit_reference", model,
             reference=reference, attributes={"Identification": "http://example.org/digitaltwin#AHU01"})
     """
-    settings = {"reference": reference, "attributes": attributes or {}}
+    settings = {"reference": reference, "attributes": attributes}
 
     for name, value in settings["attributes"].items():
         setattr(settings["reference"], name, value)

src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py

@@ -20,7 +20,7 @@
 import ifcopenshell.util.element
 
 
-def remove_library(file, library=None) -> None:
+def remove_library(file: ifcopenshell.file, library: ifcopenshell.entity_instance) -> None:
     """Removes a library
 
     All references along with their relationships will also be removed. Any

src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py

@@ -15,9 +15,12 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
 
 
-def add_constituent(file, constituent_set=None, material=None) -> None:
+def add_constituent(
+    file: ifcopenshell.file, constituent_set: ifcopenshell.entity_instance, material: ifcopenshell.entity_instance
+) -> ifcopenshell.entity_instance:
     """Adds a new constituent to a constituent set
 
     A constituent describes how a portion of an object is made out of a

src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py

@@ -15,9 +15,12 @@
 #
 # You should have received a copy of the GNU Lesser General Public License
 # along with IfcOpenShell.  If not, see <http://www.gnu.org/licenses/>.
+import ifcopenshell
 
 
-def add_layer(file, layer_set=None, material=None) -> None:
+def add_layer(
+    file: ifcopenshell.file, layer_set: ifcopenshell.entity_instance, material: ifcopenshell.entity_instance
+) -> ifcopenshell.entity_instance:
     """Adds a new layer to a layer set
 
     A layer represents a portion of material within a layered build up,

src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py

@@ -19,7 +19,9 @@
 import ifcopenshell
 
 
-def add_list_item(file, material_list=None, material=None) -> None:
+def add_list_item(
+    file: ifcopenshell.file, material_list: ifcopenshell.entity_instance, material: ifcopenshell.entity_instance
+) -> None:
     """Adds a new material in a list of materials
 
     In IFC2X3, if you wanted an object to have multiple materials (i.e. a