Skip to content

Hazards

albert.resources.hazards

HazardSymbolStatus

Bases: str, Enum

The status of a HazardSymbol.

Attributes:

Name Type Description
ACTIVE str

The hazard symbol is fully operational and visible in normal operations.

INACTIVE str

The hazard symbol is hidden from normal operations and disabled from use.

ADDED_MANUALLY str

The hazard symbol was manually chosen.

FROM_MODEL str

The hazard symbol was selected by a model.

ACTIVE

ACTIVE = 'active'

INACTIVE

INACTIVE = 'inactive'

ADDED_MANUALLY

ADDED_MANUALLY = 'Added Manually'

FROM_MODEL

FROM_MODEL = 'From Model'

HazardSymbol

Bases: EntityLinkWithName

A GHS hazard pictogram symbol from the platform reference list.

Returned by get_symbols.

Show JSON schema:
{
  "$defs": {
    "HazardSymbolStatus": {
      "description": "The status of a [`HazardSymbol`][albert.resources.hazards.HazardSymbol].\n\nAttributes\n----------\nACTIVE : str\n    The hazard symbol is fully operational and visible in normal operations.\nINACTIVE : str\n    The hazard symbol is hidden from normal operations and disabled from use.\nADDED_MANUALLY : str\n    The hazard symbol was manually chosen.\nFROM_MODEL : str\n    The hazard symbol was selected by a model.",
      "enum": [
        "active",
        "inactive",
        "Added Manually",
        "From Model"
      ],
      "title": "HazardSymbolStatus",
      "type": "string"
    }
  },
  "description": "A GHS hazard pictogram symbol from the platform reference list.\n\nReturned by\n[`get_symbols`][albert.collections.hazards.HazardsCollection.get_symbols].",
  "properties": {
    "id": {
      "title": "Id",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Category"
    },
    "status": {
      "anyOf": [
        {
          "$ref": "#/$defs/HazardSymbolStatus"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Whether the symbol is active, inactive, manually added, or selected by a model."
    }
  },
  "required": [
    "id"
  ],
  "title": "HazardSymbol",
  "type": "object"
}

Fields:

status

status: HazardSymbolStatus | None = None

Whether the symbol is active, inactive, manually added, or selected by a model.

HazardStatement

Bases: EntityLinkWithName

A GHS hazard statement from the platform reference list.

Returned by get_statements.

Show JSON schema:
{
  "description": "A GHS hazard statement from the platform reference list.\n\nReturned by\n[`get_statements`][albert.collections.hazards.HazardsCollection.get_statements].",
  "properties": {
    "id": {
      "description": "The Albert ID of the hazard statement.",
      "title": "Id",
      "type": "string"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The text of the hazard statement.",
      "title": "Name"
    },
    "category": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "The category of the hazard statement, when set.",
      "title": "Category"
    }
  },
  "required": [
    "id"
  ],
  "title": "HazardStatement",
  "type": "object"
}

Fields:

id

id: str

The Albert ID of the hazard statement.

name

name: str | None = None

The text of the hazard statement.

category

category: str | None = None

The category of the hazard statement, when set.