Specification impacted substances#

Query definition#

class SpecificationImpactedSubstancesQuery#

Gets the substances impacted by a list of legislations for Granta MI specification records.

All methods used to add specifications and legislations to this query return the query itself so that they can be chained together as required. Records can be added using a combination of any of the available methods.

Once the query is fully constructed, use the cxn. run() method to return a result of type SpecificationImpactedSubstancesQueryResult.

Examples

>>> cxn = Connection("http://my_mi_server/mi_servicelayer").with_autologon().connect()
>>> query = (
...     SpecificationImpactedSubstancesQuery()
...     .with_specification_ids(['MIL-A-8625', 'PSP101'])
...     .with_legislation_ids(["Candidate_AnnexXV"])
... )
>>> cxn.run(query)
<SpecificationImpactedSubstancesQueryResult:
                2 SpecificationWithImpactedSubstances results>

with_legislation_ids(legislation_ids)#

Add a list or set of legislations to retrieve the impacted substances for.

Legislations are identified based on their Legislation ID attribute value.

Parameters:

legislation_idslist[str] | set[str]: List or set of legislation ids.

Returns:

Query: Current query object.

Raises:

TypeError: Error to raise if the method is called with values that do not match the types described earlier.

with_specification_ids(specification_ids)#

Add a list or set of specifications to a specification query, referenced by specification ID.

Parameters:

specification_idslist[str] | set[str]: List or set of specification IDs.

Returns:

Query: Current query object.

Raises:

TypeError: Error to raise if the method is called with values that do not match the types described earlier.

Examples

>>> query = SpecificationComplianceQuery()
>>> query.with_specification_ids(['MIL-A-8625', 'PSP101'])
<SpecificationComplianceQuery: 2 specifications, batch size = 10, 0 indicators>

with_record_guids(record_guids)#

Add a list or set of record GUIDs to a query.

Parameters:

record_guidslist[str] | set[str]: List or set of record GUIDs.

Returns:

Query: Current query object.

Raises:

TypeError: Error to raise if the method is called with values that do not match the types described earlier.

Examples

>>> query = MaterialComplianceQuery()
>>> query = query.with_record_guids(['bdb0b880-e6ee-4f1a-bebd-af76959ae3c8',
>>>                                  'a98cf4b3-f96a-4714-9f79-afe443982c69'])
<MaterialCompliance: 2 materials, batch size = 100, 0 indicators>

with_record_history_guids(record_history_guids)#

Add a list or set of record history GUIDs to a query.

Parameters:

record_history_guidslist[str] | set[str]: List or set of record history GUIDs.

Returns:

Query: Current query object.

Raises:

TypeError: Error to raise if the method is called with values that do not match the types described earlier.

Examples

>>> query = MaterialComplianceQuery()
>>> query.with_record_history_guids(['41e20a88-d496-4735-a177-6266fac9b4e2',
>>>                                  'd117d9ad-e6a9-4ba9-8ad8-9a20b6d0b5e2'])
<MaterialCompliance: 2 materials, batch size = 100, 0 indicators>

with_record_history_ids(record_history_identities)#

Add a list or set of record history identities to a query.

Parameters:

record_history_identitieslist[int] | set[int]: List or set of record history identities.

Returns:

Query: Current query object.

Raises:

TypeError: Error to raise if the method is called with values that do not match the types described earlier.

Examples

>>> MaterialComplianceQuery().with_record_history_ids([15321, 17542, 942])
<MaterialCompliance: 3 materials, batch size = 50, 0 indicators>

with_batch_size(batch_size)#

Set the number of records to include in a single request for this query.

Default values are set based on typical usage of the Restricted Substances database. This value can be changed to optimize performance on a query-by-query basis if required. For example, you can change it if certain records contain particularly large or small numbers of associated records.

Parameters:

batch_sizeint: Number of records to include in a single request to Granta MI.

Returns:

Query: Current query object.

Raises:

ValueError: Error to raise if the batch size is set to a number less than 1.
TypeError: Error to raise if a value of any type other than int is specified.

Notes

The Restricted Substances database makes extensive use of tabular data and associated records to store the complex hierarchical relationships that define compliance of products, assemblies, parts, specifications, and materials. As a result, it is impossible to determine the complexity of a particular query without knowing precisely how many records are related to the record included in the query.

The default batch sizes are set for each record type and represent appropriate numbers of those records to be included in the same request assuming typical numbers of associated records.

Even if the records are queried in multiple batches, the results are assembled into a single result object.

Examples

>>> MaterialComplianceQuery().with_batch_size(50)
<MaterialCompliance: 0 materials, batch size = 50, 0 indicators>

Query result#

class SpecificationImpactedSubstancesQueryResult(results, messages)#

Retrieves the result of running the SpecificationImpactedSubstancesQuery class.

This class describes the substances in the specified specifications impacted by one or more legislations.

impacted_substances_by_specification#

Impacted substances for each specification specified in the original query. Because specifications do not have a single well-defined reference, the results are provided as a flat list.

Returns:

list[SpecificationWithImpactedSubstancesResult]

Examples

>>> result: SpecificationImpactedSubstancesQueryResult
>>> result.impacted_substances_by_specification
[<SpecificationWithImpactedSubstancesResult({SpecificationId: MIL-A-8625}),
        1 legislations>, ...]

impacted_substances_by_legislation#

View of the results for a query for impacted substances, grouped by legislation only.

The substances from all items specified in the query are merged for each legislation, providing a single list of impacted substances grouped by legislation only. Substances are duplicated where they appear in multiple items for the same legislation.

Returns:

impacted_substancesdict[str, ImpactedSubstance]

Examples

>>> result: MaterialImpactedSubstancesQueryResult
>>> result.impacted_substances_by_legislation
{'Candidate_AnnexXV': [
    <ImpactedSubstance: {"cas_number": 90481-04-2}>, ...]
}

impacted_substances#

View of the results for a query for impacted substances, flattened into a single list.

The substances from all items specified in the query are merged across item and legislation, providing a single flat list. Substances are duplicated where they appear in multiple items or legislations.

Returns:

impacted_substanceslist[ImpactedSubstance]

Examples

>>> result: MaterialImpactedSubstancesQueryResult
>>> result.impacted_substances
[<ImpactedSubstance: {"cas_number": 90481-04-2}>, ...]

messages#

Messages generated by Granta MI when running the query. The presence of one or more messages means that something unexpected happened when running the query but that the query could still be completed.

Messages are sorted in order of decreasing severity and are available in the Service Layer log file.

Messages are also logged using the Python logging module to the ansys.grantami.bomanalytics logger. By default, messages with a severity of "warning" or higher are printed on stderr.

Specification result#

class SpecificationWithImpactedSubstancesResult(legislations, **kwargs)#

Retrieves an individual specification included as part of an impacted substances query result.

This object includes two categories of attributes:

The reference to the specification in Granta MI
The impacted substances associated with this specification, both as a flat list and separated by legislation

Notes

Objects of this class are only returned as the result of a query. The class is not intended to be instantiated directly.

Examples

>>> result: SpecificationImpactedSubstancesQueryResult
>>> specification_result = result.impacted_substances_by_specification[0]
>>> specification_result.substances_by_legislation
{'Prop65': [<ImpactedSubstance: {"cas_number": 90481-04-2}>]}

>>> result: SpecificationImpactedSubstancesQueryResult
>>> specification_result = result.impacted_substances_by_specification[0]
>>> specification_result.substances
[<ImpactedSubstance: {"cas_number": 90481-04-2}>]

property record_history_identity: int | None#: Record history identity.

property record_history_guid: str | None#: Record history GUID.

property record_guid: str | None#: Record GUID.

property specification_id: str | None#: Specification ID.

property identity: str | None#

Item unique identifier.

This property is only populated on BoM query results and is equal to the id attribute of the corresponding input BoM item. If no id has been defined on the BoM item, a unique auto-generated value is assigned during analysis.

property external_identity: str | None#

Item external identity.

This property is only populated on BoM query results and is equal to the <ExternalIdentity> element of the corresponding input BoM item.

property name: str | None#

Item name.

This property is only populated on BoM query results and is equal to the <Name> element of the corresponding input BoM item.

property substances_by_legislation: Dict[str, List[ImpactedSubstance]]#: Substances impacted for this item, grouped by legislation ID.

property substances: List[ImpactedSubstance]#: Substances impacted for this item as a flattened list.