`ifcopenshell.util.doc`¶

Module Contents¶

class ifcopenshell.util.doc.BaseData¶

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

description: str¶

spec_url: str¶

class ifcopenshell.util.doc.ClassesSuggestions¶

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

name: str¶

predefined_type: NotRequired[str]¶

class ifcopenshell.util.doc.DocExtractor¶

clean_description(description)¶

clean_highlighted_words(text: str) → str¶

extract_ifc2x3()¶

extract_ifc2x3_entities()¶

extract_ifc2x3_property_sets()¶

extract_ifc2x3_property_sets_site_domains()¶

extract_ifc2x3_types()¶

extract_ifc4()¶

extract_ifc4_entities()¶

extract_ifc4_property_sets()¶

extract_ifc4_property_sets_site_domains()¶

extract_ifc4_types()¶

extract_ifc4x3()¶

extract_ifc4x3_entities()¶

extract_ifc4x3_property_sets()¶

setup_ifc2x3_reference_lookup()¶

setup_ifc4_reference_lookup()¶

class ifcopenshell.util.doc.EntityData¶

Bases: BaseData

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

attributes: NotRequired[dict[str, str]]¶

predefined_types: NotRequired[dict[str, str]]¶

class ifcopenshell.util.doc.PropertyData¶

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

children: NotRequired[dict[str, PropertyData]]¶

description: str¶

class ifcopenshell.util.doc.PsetData¶

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

description: NotRequired[str]¶

properties: dict[str, str]¶

spec_url: NotRequired[str]¶

class ifcopenshell.util.doc.SchemaData¶

Bases: TypedDict

dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s

(key, value) pairs

dict(iterable) -> new dictionary initialized as if via:: d = {} for k, v in iterable:

d[k] = v
dict(**kwargs) -> new dictionary initialized with the name=value pairs: in the keyword argument list. For example: dict(one=1, two=2)

Initialize self. See help(type(self)) for accurate signature.

classes_suggestions: dict[str, ClassesSuggestions]¶

entities: dict[str, EntityData]¶

properties: dict[str, PsetData]¶

types: dict[str, BaseData]¶

ifcopenshell.util.doc.get_attribute_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, entity: str, attribute: str, recursive=True) → str | None¶

ifcopenshell.util.doc.get_class_suggestions(version: ifcopenshell.util.schema.IFC_SCHEMA, class_name: str) → ClassesSuggestions | None¶

ifcopenshell.util.doc.get_db(version: ifcopenshell.util.schema.IFC_SCHEMA) → SchemaData | None¶

ifcopenshell.util.doc.get_entity_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, entity_name: str, recursive: bool = True) → EntityData | None¶

ifcopenshell.util.doc.get_inverse_attributes(el)¶

ifcopenshell.util.doc.get_predefined_type_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, entity: str, predefined_type: str) → str | None¶

ifcopenshell.util.doc.get_property_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, pset: str, prop: str) → str | None¶

ifcopenshell.util.doc.get_property_set_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, pset: str) → PsetData | None¶

ifcopenshell.util.doc.get_schema_by_name(version: str) → ifcopenshell.ifcopenshell_wrapper.schema_definition¶

ifcopenshell.util.doc.get_type_doc(version: ifcopenshell.util.schema.IFC_SCHEMA, ifc_type: str) → BaseData | None¶

ifcopenshell.util.doc.run_doc_api_examples()¶

ifcopenshell.util.doc.BASE_MODULE_PATH¶

ifcopenshell.util.doc.IFC2x3_DOCS_LOCATION¶

ifcopenshell.util.doc.IFC4_DOCS_LOCATION¶

ifcopenshell.util.doc.IFC4x3_DEV_LOCATION¶

ifcopenshell.util.doc.IFC4x3_HTML_LOCATION¶

ifcopenshell.util.doc.IFC4x3_SPEC_URL_TEMPLATE = 'https://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/%s.htm'¶

ifcopenshell.util.doc.SCHEMA_FILES: dict[SUPPORTED_SCHEMA, dict[str, pathlib.Path]]¶

ifcopenshell.util.doc.SUPPORTED_SCHEMA¶

ifcopenshell.util.doc.db: dict[SUPPORTED_SCHEMA, SchemaData] = None¶

ifcopenshell.util.doc.extractor¶

ifcopenshell.util.doc.schema_by_name: dict[SUPPORTED_SCHEMA, ifcopenshell.ifcopenshell_wrapper.schema_definition | None]¶

ifcopenshell.util.doc¶

Module Contents¶

`ifcopenshell.util.doc`¶