usas_tag

class usas_validator.usas_tag.USASTag(**data)[source]

Bases: BaseModel

Represents all of the properties associated with a USAS tag.

Examples

>>> from usas_validator.usas_tag import USASTag
>>> USASTag(tag="A1.1.1")
USASTag(tag='A1.1.1', number_positive_markers=0, number_negative_markers=0, rarity_marker_1=False, rarity_marker_2=False, female=False, male=False, antecedents=False, neuter=False, idiom=False)

>>> USASTag(tag="S2", female=True, male=True)
USASTag(tag='S2', number_positive_markers=0, number_negative_markers=0, rarity_marker_1=False, rarity_marker_2=False, female=True, male=True, antecedents=False, neuter=False, idiom=False)

tag: str: The USAS tag.

number_positive_markers: int: The number of positive markers.

number_negative_markers: int: The number of negative markers.

rarity_marker_1: bool: True if the USAS tag contains the rarity marker %.

rarity_marker_2: bool: True if the USAS tag contains the rarity marker @.

female: bool: True if the USAS tag contains the female marker denoted by f.

male: bool: True if the USAS tag contains the male marker denoted by m.

antecedents: bool: True if the USAS tag contains the antecedents marker denoted by c.

neuter: bool: True if the USAS tag contains the neuter marker denoted by n.

idiom: Literal[False]: False, currently not supported and therefore is always False.

class usas_validator.usas_tag.USASTagGroup(**data)[source]

Bases: BaseModel

Represents a grouping of one or more USAS tags that are associated to a token.

Examples

>>> from usas_validator.usas_tag import USASTag, USASTagGroup
>>> USASTagGroup(tags=[USASTag(tag="A1.1.1")])
USASTagGroup(tags=[USASTag(tag='A1.1.1', number_positive_markers=0, number_negative_markers=0, rarity_marker_1=False, rarity_marker_2=False, female=False, male=False, antecedents=False, neuter=False, idiom=False)])

>>> USASTagGroup(tags=[USASTag(tag="E2", number_negative_markers=1), USASTag(tag="S7.1", number_positive_markers=1)])
USASTagGroup(tags=[USASTag(tag='E2', number_positive_markers=0, number_negative_markers=1, rarity_marker_1=False, rarity_marker_2=False, female=False, male=False, antecedents=False, neuter=False, idiom=False), USASTag(tag='S7.1', number_positive_markers=1, number_negative_markers=0, rarity_marker_1=False, rarity_marker_2=False, female=False, male=False, antecedents=False, neuter=False, idiom=False)])

tags: list[USASTag]: A list of USAS tags that are associated to a token. This grouping of USAS tags is a way of representing multi tag membership.

property tag_strings: list[str]

The raw USAS tag string of each tag in the group.

Returns:: The tag attribute of every USASTag in tags, in order.

Examples

>>> from usas_validator.usas_tag import USASTag, USASTagGroup
>>> group = USASTagGroup(tags=[USASTag(tag="E2"), USASTag(tag="S7.1")])
>>> group.tag_strings
['E2', 'S7.1']