`bsdd`¶

Module Contents¶

class bsdd.ClassContractV1¶

Bases: TypedDict

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

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.

activationDateUtc: str¶

childClassReferences: typing_extensions.NotRequired[list[ClassReferenceContractV1]]¶

classProperties: typing_extensions.NotRequired[list[ClassPropertyContractV1]]¶

classRelations: typing_extensions.NotRequired[list[ClassRelationContractV1]]¶

classType: typing_extensions.NotRequired[str]¶

code: str¶

countriesOfUse: typing_extensions.NotRequired[list[str]]¶

countryOfOrigin: typing_extensions.NotRequired[str]¶

creatorLanguageCode: typing_extensions.NotRequired[str]¶

deActivationDateUtc: typing_extensions.NotRequired[str]¶

definition: typing_extensions.NotRequired[str]¶

deprecationExplanation: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

dictionaryUri: typing_extensions.NotRequired[str]¶

documentReference: typing_extensions.NotRequired[str]¶

hierarchy: typing_extensions.NotRequired[list[HierarchyItemContractV1]]¶

name: str¶

parentClassReference: typing_extensions.NotRequired[ClassReferenceContractV1]¶

referenceCode: typing_extensions.NotRequired[str]¶

relatedIfcEntityNames: typing_extensions.NotRequired[list[str]]¶

replacedObjectCodes: typing_extensions.NotRequired[list[str]]¶

replacingObjectCodes: typing_extensions.NotRequired[list[str]]¶

reverseClassRelations: typing_extensions.NotRequired[list[ClassReverseRelationContractV1]]¶

revisionDateUtc: typing_extensions.NotRequired[str]¶

revisionNumber: typing_extensions.NotRequired[int]¶

status: str¶

subdivisionsOfUse: typing_extensions.NotRequired[list[str]]¶

synonyms: typing_extensions.NotRequired[list[str]]¶

uid: typing_extensions.NotRequired[str]¶

uri: str¶

versionDateUtc: str¶

versionNumber: typing_extensions.NotRequired[int]¶

visualRepresentationUri: typing_extensions.NotRequired[str]¶

class bsdd.ClassListItemContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[list[ClassListItemContractV1]]¶

classType: typing_extensions.NotRequired[str]¶

code: typing_extensions.NotRequired[str]¶

descriptionPart: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

parentClassCode: typing_extensions.NotRequired[str]¶

referenceCode: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.ClassPropertyContractV1¶

Bases: TypedDict

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

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.

allowedValues: typing_extensions.NotRequired[list[ClassPropertyValueContractV1]]¶

dataType: typing_extensions.NotRequired[str]¶

definition: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

dimension: typing_extensions.NotRequired[str]¶

dimensionAmountOfSubstance: typing_extensions.NotRequired[int]¶

dimensionElectricCurrent: typing_extensions.NotRequired[int]¶

dimensionLength: typing_extensions.NotRequired[int]¶

dimensionLuminousIntensity: typing_extensions.NotRequired[int]¶

dimensionMass: typing_extensions.NotRequired[int]¶

dimensionThermodynamicTemperature: typing_extensions.NotRequired[int]¶

dimensionTime: typing_extensions.NotRequired[int]¶

dynamicParameterPropertyCodes: typing_extensions.NotRequired[list[str]]¶

example: typing_extensions.NotRequired[str]¶

isDynamic: typing_extensions.NotRequired[bool]¶

isRequired: typing_extensions.NotRequired[bool]¶

isWritable: typing_extensions.NotRequired[bool]¶

maxExclusive: typing_extensions.NotRequired[float]¶

maxInclusive: typing_extensions.NotRequired[float]¶

minExclusive: typing_extensions.NotRequired[float]¶

minInclusive: typing_extensions.NotRequired[float]¶

name: str¶

pattern: typing_extensions.NotRequired[str]¶

physicalQuantity: typing_extensions.NotRequired[str]¶

predefinedValue: typing_extensions.NotRequired[str]¶

propertyCode: typing_extensions.NotRequired[str]¶

propertyDictionaryName: typing_extensions.NotRequired[str]¶

propertyDictionaryUri: typing_extensions.NotRequired[str]¶

propertySet: typing_extensions.NotRequired[str]¶

propertyStatus: typing_extensions.NotRequired[str]¶

propertyUri: typing_extensions.NotRequired[str]¶

propertyValueKind: typing_extensions.NotRequired[str]¶

qudtCodes: typing_extensions.NotRequired[list[str]]¶

symbol: typing_extensions.NotRequired[str]¶

units: typing_extensions.NotRequired[list[str]]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.ClassPropertyValueContractV1¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

sortNumber: typing_extensions.NotRequired[int]¶

uri: typing_extensions.NotRequired[str]¶

value: str¶

class bsdd.ClassReferenceContractV1¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

uri: str¶

class bsdd.ClassRelationContractV1¶

Bases: TypedDict

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

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.

fraction: typing_extensions.NotRequired[float]¶

relatedClassName: typing_extensions.NotRequired[str]¶

relatedClassUri: str¶

relationType: str¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.ClassReverseRelationContractV1¶

Bases: TypedDict

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

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.

className: typing_extensions.NotRequired[str]¶

classUri: str¶

dictionaryUri: typing_extensions.NotRequired[str]¶

fraction: typing_extensions.NotRequired[float]¶

relationType: str¶

class bsdd.ClassSearchResponseClassContractV1¶

Bases: TypedDict

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

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.

classType: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

dictionaryName: typing_extensions.NotRequired[str]¶

dictionaryUri: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

parentClassName: typing_extensions.NotRequired[str]¶

referenceCode: typing_extensions.NotRequired[str]¶

relatedIfcEntityNames: typing_extensions.NotRequired[list[str]]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.ClassSearchResponseContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[list[ClassSearchResponseClassContractV1]]¶

count: typing_extensions.NotRequired[int]¶

offset: typing_extensions.NotRequired[int]¶

totalCount: typing_extensions.NotRequired[int]¶

class bsdd.ClassSearchResultContractV1¶

Bases: TypedDict

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

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.

classType: typing_extensions.NotRequired[str]¶

definition: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

referenceCode: typing_extensions.NotRequired[str]¶

synonyms: typing_extensions.NotRequired[list[str]]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.Client¶

Classification(namespaceUri, version='v3', languageCode='', includeChildClassificationReferences=True)¶

ClassificationSearchOpen(SearchText, version='v1', DomainNamespaceUris=None, RelatedIfcEntities=None)¶

Country(version='v1')¶

Domain(version='v2')¶

Language(version='v1')¶

Property(namespaceUri, version='v2', languageCode='')¶

PropertyValue(namespaceUri, version='v1', languageCode='')¶

ReferenceDocument(version='v1')¶

SearchList(DomainNamespaceUri, version='v2', SearchText='', LanguageCode='', RelatedIfcEntity='')¶

SearchListOpen(DomainNamespaceUri, version='v2', SearchText='', LanguageCode='', RelatedIfcEntity='')¶

Unit(version='v1')¶

get(endpoint, params=None, is_auth_required=False)¶

get_access_token()¶

get_class(class_uri: str, include_class_properties: bool = True, include_child_class_reference: bool = True, include_class_relations: bool = True, include_reverse_relations: bool = False, reverse_relation_dictionary_uris: list[str] | None = None, language_code: str = '', version: int = 1) → ClassContractV1¶: Get Class details this API replaces Classification

get_classes(dictionary_uri: str, use_nested_classes: bool = True, class_type: ClassTypes = 'Class', language_code: str = '', version: int = 1, offset=0, limit=1000) → DictionaryClassesResponseContractV1¶: Get Dictionary with tree of classes This API replaces Domain

get_countries(version: int = 1) → list[CountryContractV1]¶: Get list of all Countries this API replaces Country

get_dictionary(dictionary_uri: str = '', version: int = 1) → DictionaryResponseContractV1¶: Get list of available Dictionaries This API replaces Domain

get_languages(version: int = 1) → list[LanguageContractV1]¶: Get list of available Languages this API replaces Language

get_new_access_token()¶

get_properties(dictionary_uri: str, offset: int = 0, limit: int = 100, language_code: str = '', version: int = 1) → DictionaryPropertiesResponseContractV1¶: Get Dictionary with its properties

get_property(uri, include_classes=False, language_code='', version: int = 4) → PropertyContractV4¶: Get Property Detail this API replaces Property

get_property_value(uri, language_code='', version: int = 2) → PropertyValueContractV4¶: Get Property Value details this API replaces PropertyValue

get_reference_documents(version: int = 1) → list[ReferenceDocumentContractV1]¶: Get list of all ReferenceDocuments this API replaces Country

get_units(version: int = 1) → list[UnitContractV1]¶: Get list of all Units this API replaces Unit

login()¶

post()¶

search_class(search_text: str, dictionary_uris: list[str] | None = None, related_ifc_entities: list[str] | None = None, version: int = 1, offset: int = 0, limit: int = 100) → ClassSearchResponseContractV1¶: Search the bSDD database using free text, get list of Classes matching the text and optional additional filters. this API replaces ClassificationSearch

search_in_dictionary(dictionary_uri: str, search_text: str = '', language_code: str = '', related_ifc_entity: str = '', version: int = 1, offset: int = 0, limit: int = 100) → SearchInDictionaryResponseContractV1¶: Search the bSDD database, get list of Classes without details. This version uses new naming and returns one Dictionary instead of a list with always one Dictionary. This API replaces SearchList.

search_text(search_text: str, type_filter='All', dictionary_uris=None, version: int = 1, offset: int = 0, limit: int = 100) → TextSearchResponseContractV1¶: Search the bSDD database using free text, get list of Classes and/or Properties matching the text. Pagination options are for Classes and Properties combined. So if result consists of 10 classes and 5 properties, TotalCount will be 15. Classes will be listed first, so if you then use Offset=10 and Limit=5, you will get the 5 properties.

set_tokens_from_response(response)¶

access_token = ''¶

access_token_expires_on¶

auth_endpoint = 'https://buildingsmartservices.b2clogin.com/tfp/buildingsmartservices.onmicrosoft.com/b2c_1_signu...¶

baseurl = 'https://api.bsdd.buildingsmart.org/api/'¶

client_id = '4aba821f-d4ff-498b-a462-c2837dbbba70'¶

refresh_token = ''¶

refresh_token_expires_on¶

token_endpoint = 'https://buildingsmartservices.b2clogin.com/tfp/buildingsmartservices.onmicrosoft.com/b2c_1_signu...¶

class bsdd.CodeNameDto¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

class bsdd.CountryContractV1¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

class bsdd.DictionaryClassesResponseContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[list[ClassListItemContractV1]]¶

classesCount: typing_extensions.NotRequired[int]¶

classesOffset: typing_extensions.NotRequired[int]¶

classesTotalCount: typing_extensions.NotRequired[int]¶

code: str¶

defaultLanguageCode: str¶

isLatestVersion: bool¶

isVerified: bool¶

lastUpdatedUtc: typing_extensions.NotRequired[str]¶

license: typing_extensions.NotRequired[str]¶

licenseUrl: typing_extensions.NotRequired[str]¶

moreInfoUrl: typing_extensions.NotRequired[str]¶

name: str¶

organizationCodeOwner: str¶

organizationNameOwner: str¶

qualityAssuranceProcedure: typing_extensions.NotRequired[str]¶

qualityAssuranceProcedureUrl: typing_extensions.NotRequired[str]¶

releaseDate: typing_extensions.NotRequired[str]¶

status: typing_extensions.NotRequired[str]¶

uri: str¶

version: str¶

class bsdd.DictionaryContractV1¶

Bases: TypedDict

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

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.

availableLanguages: typing_extensions.NotRequired[list[CodeNameDto]]¶

code: str¶

defaultLanguageCode: str¶

isLatestVersion: bool¶

isVerified: bool¶

lastUpdatedUtc: typing_extensions.NotRequired[str]¶

license: typing_extensions.NotRequired[str]¶

licenseUrl: typing_extensions.NotRequired[str]¶

moreInfoUrl: typing_extensions.NotRequired[str]¶

name: str¶

organizationCodeOwner: str¶

organizationNameOwner: str¶

qualityAssuranceProcedure: typing_extensions.NotRequired[str]¶

qualityAssuranceProcedureUrl: typing_extensions.NotRequired[str]¶

releaseDate: typing_extensions.NotRequired[str]¶

status: typing_extensions.NotRequired[str]¶

uri: str¶

version: str¶

class bsdd.DictionaryPropertiesResponseContractV1¶

Bases: TypedDict

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

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.

code: str¶

defaultLanguageCode: str¶

isLatestVersion: bool¶

isVerified: bool¶

lastUpdatedUtc: typing_extensions.NotRequired[str]¶

license: typing_extensions.NotRequired[str]¶

licenseUrl: typing_extensions.NotRequired[str]¶

moreInfoUrl: typing_extensions.NotRequired[str]¶

name: str¶

organizationCodeOwner: str¶

organizationNameOwner: str¶

properties: typing_extensions.NotRequired[list[PropertyListItemContractV1]]¶

propertiesCount: typing_extensions.NotRequired[int]¶

propertiesOffset: typing_extensions.NotRequired[int]¶

propertiesTotalCount: typing_extensions.NotRequired[int]¶

qualityAssuranceProcedure: typing_extensions.NotRequired[str]¶

qualityAssuranceProcedureUrl: typing_extensions.NotRequired[str]¶

releaseDate: typing_extensions.NotRequired[str]¶

status: typing_extensions.NotRequired[str]¶

uri: str¶

version: str¶

class bsdd.DictionaryResponseContractV1¶

Bases: TypedDict

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

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.

count: typing_extensions.NotRequired[int]¶

dictionaries: typing_extensions.NotRequired[list[DictionaryContractV1]]¶

offset: typing_extensions.NotRequired[int]¶

totalCount: typing_extensions.NotRequired[int]¶

class bsdd.DictionarySearchResultContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[list[ClassSearchResultContractV1]]¶

name: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.HierarchyItemContractV1¶

Bases: TypedDict

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

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.

code: str¶

level: int¶

name: str¶

uri: str¶

class bsdd.LanguageContractV1¶

Bases: TypedDict

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

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.

isoCode: str¶

name: str¶

class bsdd.OAuthReceiver(request, client_address, server)¶

Bases: http.server.BaseHTTPRequestHandler

HTTP request handler base class.

The following explanation of HTTP serves to guide you through the code as well as to expose any misunderstandings I may have about HTTP (so you don’t need to read the code to figure out I’m wrong :-).

HTTP (HyperText Transfer Protocol) is an extensible protocol on top of a reliable stream transport (e.g. TCP/IP). The protocol recognizes three parts to a request:

One line identifying the request type and path
An optional set of RFC-822-style headers
An optional data part

The headers and data are separated by a blank line.

The first line of the request has the form

where <command> is a (case-sensitive) keyword such as GET or POST, <path> is a string containing path information for the request, and <version> should be the string “HTTP/1.0” or “HTTP/1.1”. <path> is encoded using the URL encoding scheme (using %xx to signify the ASCII character with hex code xx).

The specification specifies that lines are separated by CRLF but for compatibility with the widest range of clients recommends servers also handle LF. Similarly, whitespace in the request line is treated sensibly (allowing multiple spaces between components and allowing trailing whitespace).

Similarly, for output, lines ought to be separated by CRLF pairs but most clients grok LF characters just fine.

If the first line of the request has the form

(i.e. <version> is left out) then this is assumed to be an HTTP 0.9 request; this form has no optional headers and data part and the reply consists of just the data.

The reply form of the HTTP 1.x protocol again has three parts:

One line giving the response code
An optional set of RFC-822-style headers
The data

Again, the headers and data are separated by a blank line.

The response code line has the form

where <version> is the protocol version (“HTTP/1.0” or “HTTP/1.1”), <responsecode> is a 3-digit response code indicating success or failure of the request, and <responsestring> is an optional human-readable string explaining what the response code means.

This server parses the request and the headers, and then calls a function specific to the request type (<command>). Specifically, a request SPAM will be handled by a method do_SPAM(). If no such method exists the server sends an error response to the client. If it exists, it is called with no arguments:

do_SPAM()

Note that the request name is case sensitive (i.e. SPAM and spam are different requests).

The various request details are stored in instance variables:

client_address is the client IP address in the form (host,

port);

command, path and version are the broken-down request line;
headers is an instance of email.message.Message (or a derived

class) containing the header information;

rfile is a file object open for reading positioned at the

start of the optional input data part;

wfile is a file object open for writing.

IT IS IMPORTANT TO ADHERE TO THE PROTOCOL FOR WRITING!

The first thing to be written must be the response line. Then follow 0 or more header lines, then a blank line, and then the actual data (if any). The meaning of the header lines depends on the command executed by the server; in most cases, when data is returned, there should be at least one header line of the form

Content-type: <type>/<subtype>

where <type> and <subtype> should be registered MIME types, e.g. “text/html” or “text/plain”.

do_GET()¶

class bsdd.PropertyClassContractV4¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

definition: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

name: str¶

propertySet: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.PropertyContractV4¶

Bases: TypedDict

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

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.

activationDateUtc: str¶

allowedValues: typing_extensions.NotRequired[list[PropertyValueContractV4]]¶

code: str¶

connectedPropertyCodes: typing_extensions.NotRequired[list[str]]¶

countriesOfUse: typing_extensions.NotRequired[list[str]]¶

countryOfOrigin: typing_extensions.NotRequired[str]¶

creatorLanguageCode: typing_extensions.NotRequired[str]¶

dataType: typing_extensions.NotRequired[str]¶

deActivationDateUtc: typing_extensions.NotRequired[str]¶

definition: typing_extensions.NotRequired[str]¶

deprecationExplanation: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

dictionaryUri: typing_extensions.NotRequired[str]¶

dimension: typing_extensions.NotRequired[str]¶

dimensionAmountOfSubstance: typing_extensions.NotRequired[int]¶

dimensionElectricCurrent: typing_extensions.NotRequired[int]¶

dimensionLength: typing_extensions.NotRequired[int]¶

dimensionLuminousIntensity: typing_extensions.NotRequired[int]¶

dimensionMass: typing_extensions.NotRequired[int]¶

dimensionThermodynamicTemperature: typing_extensions.NotRequired[int]¶

dimensionTime: typing_extensions.NotRequired[int]¶

documentReference: typing_extensions.NotRequired[str]¶

dynamicParameterPropertyCodes: typing_extensions.NotRequired[list[str]]¶

example: typing_extensions.NotRequired[str]¶

isDynamic: typing_extensions.NotRequired[bool]¶

maxExclusive: typing_extensions.NotRequired[float]¶

maxInclusive: typing_extensions.NotRequired[float]¶

methodOfMeasurement: typing_extensions.NotRequired[str]¶

minExclusive: typing_extensions.NotRequired[float]¶

minInclusive: typing_extensions.NotRequired[float]¶

name: str¶

pattern: typing_extensions.NotRequired[str]¶

physicalQuantity: typing_extensions.NotRequired[str]¶

propertyClasses: typing_extensions.NotRequired[list[PropertyClassContractV4]]¶

propertyRelations: typing_extensions.NotRequired[list[PropertyRelationContractV4]]¶

propertyValueKind: typing_extensions.NotRequired[str]¶

qudtCodes: typing_extensions.NotRequired[list[str]]¶

replacedObjectCodes: typing_extensions.NotRequired[list[str]]¶

replacingObjectCodes: typing_extensions.NotRequired[list[str]]¶

revisionDateUtc: typing_extensions.NotRequired[str]¶

revisionNumber: typing_extensions.NotRequired[int]¶

status: str¶

subdivisionsOfUse: typing_extensions.NotRequired[list[str]]¶

textFormat: typing_extensions.NotRequired[str]¶

uid: typing_extensions.NotRequired[str]¶

units: typing_extensions.NotRequired[list[str]]¶

uri: str¶

versionDateUtc: str¶

versionNumber: typing_extensions.NotRequired[int]¶

visualRepresentationUri: typing_extensions.NotRequired[str]¶

class bsdd.PropertyListItemContractV1¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

descriptionPart: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.PropertyRelationContractV4¶

Bases: TypedDict

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

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.

relatedPropertyName: typing_extensions.NotRequired[str]¶

relatedPropertyUri: typing_extensions.NotRequired[str]¶

relationType: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.PropertyValueContractV4¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

sortNumber: typing_extensions.NotRequired[int]¶

uri: typing_extensions.NotRequired[str]¶

value: str¶

class bsdd.ReferenceDocumentContractV1¶

Bases: TypedDict

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

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.

date: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

title: typing_extensions.NotRequired[str]¶

class bsdd.SearchInDictionaryResponseContractV1¶

Bases: TypedDict

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

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.

count: typing_extensions.NotRequired[int]¶

dictionary: typing_extensions.NotRequired[DictionarySearchResultContractV1]¶

offset: typing_extensions.NotRequired[int]¶

totalCount: typing_extensions.NotRequired[int]¶

class bsdd.TextSearchResponseClassContractV1¶

Bases: TypedDict

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

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.

classType: typing_extensions.NotRequired[str]¶

description: typing_extensions.NotRequired[str]¶

dictionaryName: typing_extensions.NotRequired[str]¶

dictionaryUri: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

parentClassName: typing_extensions.NotRequired[str]¶

referenceCode: typing_extensions.NotRequired[str]¶

relatedIfcEntityNames: typing_extensions.NotRequired[list[str]]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.TextSearchResponseContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[list[TextSearchResponseClassContractV1]]¶

count: typing_extensions.NotRequired[int]¶

dictionaries: typing_extensions.NotRequired[list[TextSearchResponseDictionaryContractV1]]¶

offset: typing_extensions.NotRequired[int]¶

properties: typing_extensions.NotRequired[list[TextSearchResponsePropertyContractV1]]¶

totalCount: typing_extensions.NotRequired[int]¶

class bsdd.TextSearchResponseDictionaryContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.TextSearchResponsePropertyContractV1¶

Bases: TypedDict

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

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: typing_extensions.NotRequired[str]¶

dictionaryName: typing_extensions.NotRequired[str]¶

dictionaryUri: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

uri: typing_extensions.NotRequired[str]¶

class bsdd.UnitContractV1¶

Bases: TypedDict

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

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.

code: typing_extensions.NotRequired[str]¶

name: typing_extensions.NotRequired[str]¶

qudtUri: typing_extensions.NotRequired[str]¶

symbol: typing_extensions.NotRequired[str]¶

bsdd.apply_ifc_classification_properties(ifc_file, element, classificationProperties)¶

bsdd.ClassTypes¶

bsdd.Status¶

bsdd¶

Module Contents¶

`bsdd`¶