schema-org-python 0.1.0__py3-none-any.whl

schema_models/statement.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work import CreativeWork
+
+
+class Statement(CreativeWork):
+    """
+    A statement about something, for example a fun or interesting fact. If known, the main entity this statement is about can be indicated using mainEntity. For more formal claims (e.g. in Fact Checking), consider using [[Claim]] instead. Use the [[text]] property to capture the text of the statement.
+    """

schema_models/statistical_population.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class StatisticalPopulation(Intangible):
+    """
+    A StatisticalPopulation is a set of instances of a certain given type that satisfy some set of constraints. The property [[populationType]] is used to specify the type. Any property that can be used on instances of that type can appear on the statistical population. For example, a [[StatisticalPopulation]] representing all [[Person]]s with a [[homeLocation]] of East Podunk California would be described by applying the appropriate [[homeLocation]] and [[populationType]] properties to a [[StatisticalPopulation]] item that stands for that set of people.
+    The properties [[numConstraints]] and [[constraintProperty]] are used to specify which of the populations properties are used to specify the population. Note that the sense of "population" used here is the general sense of a statistical
+    population, and does not imply that the population consists of people. For example, a [[populationType]] of [[Event]] or [[NewsArticle]] could be used. See also [[Observation]], where a [[populationType]] such as [[Person]] or [[Event]] can be indicated directly. In most cases it may be better to use [[StatisticalVariable]] instead of [[StatisticalPopulation]].
+    """
+
+    populationType: Optional[Union["_Class", List["_Class"]]] = None

schema_models/statistical_variable.py

@@ -0,0 +1,50 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.__class import _Class
+from schema_models.constraint_node import ConstraintNode
+from schema_models.defined_term import DefinedTerm
+from schema_models.enumeration import Enumeration
+from schema_models.measurement_method_enum import MeasurementMethodEnum
+from schema_models.property import Property
+
+
+class StatisticalVariable(ConstraintNode):
+    """
+    [[StatisticalVariable]] represents any type of statistical metric that can be measured at a place and time. The usage pattern for [[StatisticalVariable]] is typically expressed using [[Observation]] with an explicit [[populationType]], which is a type, typically drawn from Schema.org. Each [[StatisticalVariable]] is marked as a [[ConstraintNode]], meaning that some properties (those listed using [[constraintProperty]]) serve in this setting solely to define the statistical variable rather than literally describe a specific person, place or thing. For example, a [[StatisticalVariable]] Median_Height_Person_Female representing the median height of women, could be written as follows: the population type is [[Person]]; the measuredProperty [[height]]; the [[statType]] [[median]]; the [[gender]] [[Female]]. It is important to note that there are many kinds of scientific quantitative observation which are not fully, perfectly or unambiguously described following this pattern, or with solely Schema.org terminology. The approach taken here is designed to allow partial, incremental or minimal description of [[StatisticalVariable]]s, and the use of detailed sets of entity and property IDs from external repositories. The [[measurementMethod]], [[unitCode]] and [[unitText]] properties can also be used to clarify the specific nature and notation of an observed measurement.
+    """
+
+    measurementDenominator: Optional[
+        Union["StatisticalVariable", List["StatisticalVariable"]]
+    ] = None
+    populationType: Optional[Union[_Class, List[_Class]]] = None
+    measurementTechnique: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+        ]
+    ] = None
+    measurementQualifier: Optional[Union[Enumeration, List[Enumeration]]] = None
+    measuredProperty: Optional[Union[Property, List[Property]]] = None
+    measurementMethod: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+            str,
+            List[str],
+        ]
+    ] = None
+    statType: Optional[
+        Union[Property, List[Property], str, List[str], HttpUrl, List[HttpUrl]]
+    ] = None

schema_models/status_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class StatusEnumeration(Enumeration):
+    """
+    Lists or enumerations dealing with status types.
+    """

schema_models/steering_position_value.py

@@ -0,0 +1,7 @@
+from schema_models.qualitative_value import QualitativeValue
+
+
+class SteeringPositionValue(QualitativeValue):
+    """
+    A value indicating a steering position.
+    """

schema_models/store.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class Store(LocalBusiness):
+    """
+    A retail good store.
+    """

schema_models/structured_value.py

@@ -0,0 +1,7 @@
+from schema_models.intangible import Intangible
+
+
+class StructuredValue(Intangible):
+    """
+    Structured values are used when the value of a property has a more complex structure than simply being a textual value or a reference to another thing.
+    """

schema_models/stupid_type.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.thing import Thing
+
+
+class StupidType(Thing):
+    """
+    A StupidType for testing.
+    """
+
+    stupidProperty: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = (
+        None
+    )

schema_models/subscribe_action.py

@@ -0,0 +1,13 @@
+from schema_models.interact_action import InteractAction
+
+
+class SubscribeAction(InteractAction):
+    """
+    The act of forming a personal connection with someone/something (object) unidirectionally/asymmetrically to get updates pushed to.
+
+    Related actions:
+
+    * [[FollowAction]]: Unlike FollowAction, SubscribeAction implies that the subscriber acts as a passive agent being constantly/actively pushed for updates.
+    * [[RegisterAction]]: Unlike RegisterAction, SubscribeAction implies that the agent is interested in continuing receiving updates from the object.
+    * [[JoinAction]]: Unlike JoinAction, SubscribeAction implies that the agent is interested in continuing receiving updates from the object.
+    """

schema_models/substance.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_entity import MedicalEntity
+
+
+class Substance(MedicalEntity):
+    """
+    Any matter of defined composition that has discrete existence, whose origin may be biological, mineral or chemical.
+    """
+
+    activeIngredient: Optional[Union[str, List[str]]] = None
+    maximumIntake: Optional[
+        Union["MaximumDoseSchedule", List["MaximumDoseSchedule"]]
+    ] = None

schema_models/subway_station.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class SubwayStation(CivicStructure):
+    """
+    A subway station.
+    """

schema_models/suite.py

@@ -0,0 +1,22 @@
+from typing import List, Optional, Union
+
+from schema_models.accommodation import Accommodation
+from schema_models.bed_details import BedDetails
+from schema_models.quantitative_value import QuantitativeValue
+
+
+class Suite(Accommodation):
+    """
+    A suite in a hotel or other public accommodation, denotes a class of luxury accommodations, the key feature of which is multiple rooms (source: Wikipedia, the free encyclopedia, see <a href="http://en.wikipedia.org/wiki/Suite_(hotel)">http://en.wikipedia.org/wiki/Suite_(hotel)</a>).
+    <br /><br />
+    See also the <a href="/docs/hotels.html">dedicated document on the use of schema.org for marking up hotels and other forms of accommodations</a>.
+
+    """
+
+    occupancy: Optional[Union[QuantitativeValue, List[QuantitativeValue]]] = None
+    numberOfRooms: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue], float, List[float]]
+    ] = None
+    bed: Optional[
+        Union["BedType", List["BedType"], BedDetails, List[BedDetails], str, List[str]]
+    ] = None

schema_models/superficial_anatomy.py

@@ -0,0 +1,24 @@
+from typing import List, Optional, Union
+
+from schema_models.anatomical_system import AnatomicalSystem
+from schema_models.medical_condition import MedicalCondition
+from schema_models.medical_entity import MedicalEntity
+
+
+class SuperficialAnatomy(MedicalEntity):
+    """
+    Anatomical features that can be observed by sight (without dissection), including the form and proportions of the human body as well as surface landmarks that correspond to deeper subcutaneous structures. Superficial anatomy plays an important role in sports medicine, phlebotomy, and other medical specialties as underlying anatomical structures can be identified through surface palpation. For example, during back surgery, superficial anatomy can be used to palpate and count vertebrae to find the site of incision. Or in phlebotomy, superficial anatomy can be used to locate an underlying vein; for example, the median cubital vein can be located by palpating the borders of the cubital fossa (such as the epicondyles of the humerus) and then looking for the superficial signs of the vein, such as size, prominence, ability to refill after depression, and feel of surrounding tissue support. As another example, in a subluxation (dislocation) of the glenohumeral joint, the bony structure becomes pronounced with the deltoid muscle failing to cover the glenohumeral joint allowing the edges of the scapula to be superficially visible. Here, the superficial anatomy is the visible edges of the scapula, implying the underlying dislocation of the joint (the related anatomical structure).
+    """
+
+    relatedCondition: Optional[Union[MedicalCondition, List[MedicalCondition]]] = None
+    significance: Optional[Union[str, List[str]]] = None
+    relatedAnatomy: Optional[
+        Union[
+            AnatomicalSystem,
+            List[AnatomicalSystem],
+            "AnatomicalStructure",
+            List["AnatomicalStructure"],
+        ]
+    ] = None
+    relatedTherapy: Optional[Union["MedicalTherapy", List["MedicalTherapy"]]] = None
+    associatedPathophysiology: Optional[Union[str, List[str]]] = None

schema_models/surgical_procedure.py

@@ -0,0 +1,7 @@
+from schema_models.medical_procedure import MedicalProcedure
+
+
+class SurgicalProcedure(MedicalProcedure):
+    """
+    A medical procedure involving an incision with instruments; performed for diagnose, or therapeutic purposes.
+    """

schema_models/suspend_action.py

@@ -0,0 +1,7 @@
+from schema_models.control_action import ControlAction
+
+
+class SuspendAction(ControlAction):
+    """
+    The act of momentarily pausing a device or application (e.g. pause music playback or pause a timer).
+    """

schema_models/syllabus.py

@@ -0,0 +1,7 @@
+from schema_models.learning_resource import LearningResource
+
+
+class Syllabus(LearningResource):
+    """
+    A syllabus that describes the material covered in a course, often with several such sections per [[Course]] so that a distinct [[timeRequired]] can be provided for that section of the [[Course]].
+    """

schema_models/synagogue.py

@@ -0,0 +1,7 @@
+from schema_models.place_of_worship import PlaceOfWorship
+
+
+class Synagogue(PlaceOfWorship):
+    """
+    A synagogue.
+    """

schema_models/table.py

@@ -0,0 +1,7 @@
+from schema_models.web_page_element import WebPageElement
+
+
+class Table(WebPageElement):
+    """
+    A table on a Web page.
+    """

schema_models/take_action.py

@@ -0,0 +1,12 @@
+from schema_models.transfer_action import TransferAction
+
+
+class TakeAction(TransferAction):
+    """
+    The act of gaining ownership of an object from an origin. Reciprocal of GiveAction.
+
+    Related actions:
+
+    * [[GiveAction]]: The reciprocal of TakeAction.
+    * [[ReceiveAction]]: Unlike ReceiveAction, TakeAction implies that ownership has been transferred.
+    """

schema_models/tattoo_parlor.py

@@ -0,0 +1,7 @@
+from schema_models.health_and_beauty_business import HealthAndBeautyBusiness
+
+
+class TattooParlor(HealthAndBeautyBusiness):
+    """
+    A tattoo parlor.
+    """

schema_models/taxi.py

@@ -0,0 +1,7 @@
+from schema_models.service import Service
+
+
+class Taxi(Service):
+    """
+    A taxi.
+    """

schema_models/taxi_reservation.py

@@ -0,0 +1,19 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from schema_models.place import Place
+from schema_models.reservation import Reservation
+
+
+class TaxiReservation(Reservation):
+    """
+    A reservation for a taxi.
+
+    Note: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, use [[Offer]].
+    """
+
+    partySize: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"], int, List[int]]
+    ] = None
+    pickupTime: Optional[Union[datetime, List[datetime]]] = None
+    pickupLocation: Optional[Union[Place, List[Place]]] = None

schema_models/taxi_service.py

@@ -0,0 +1,7 @@
+from schema_models.service import Service
+
+
+class TaxiService(Service):
+    """
+    A service for a vehicle for hire with a driver for local travel. Fares are usually calculated based on distance traveled.
+    """

schema_models/taxi_stand.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class TaxiStand(CivicStructure):
+    """
+    A taxi stand.
+    """

schema_models/taxon.py

@@ -0,0 +1,29 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.thing import Thing
+
+
+class Taxon(Thing):
+    """
+    A set of organisms asserted to represent a natural cohesive biological unit.
+    """
+
+    hasDefinedTerm: Optional[Union["DefinedTerm", List["DefinedTerm"]]] = None
+    taxonRank: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            "PropertyValue",
+            List["PropertyValue"],
+        ]
+    ] = None
+    childTaxon: Optional[
+        Union[str, List[str], HttpUrl, List[HttpUrl], "Taxon", List["Taxon"]]
+    ] = None
+    parentTaxon: Optional[
+        Union["Taxon", List["Taxon"], str, List[str], HttpUrl, List[HttpUrl]]
+    ] = None

schema_models/tech_article.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.article import Article
+
+
+class TechArticle(Article):
+    """
+    A technical article - Example: How-to (task) topics, step-by-step, procedural troubleshooting, specifications, etc.
+    """
+
+    proficiencyLevel: Optional[Union[str, List[str]]] = None
+    dependencies: Optional[Union[str, List[str]]] = None

schema_models/television_channel.py

@@ -0,0 +1,7 @@
+from schema_models.broadcast_channel import BroadcastChannel
+
+
+class TelevisionChannel(BroadcastChannel):
+    """
+    A unique instance of a television BroadcastService on a CableOrSatelliteService lineup.
+    """

schema_models/television_station.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class TelevisionStation(LocalBusiness):
+    """
+    A television station.
+    """

schema_models/tennis_complex.py

@@ -0,0 +1,7 @@
+from schema_models.sports_activity_location import SportsActivityLocation
+
+
+class TennisComplex(SportsActivityLocation):
+    """
+    A tennis complex.
+    """

schema_models/text.py

@@ -0,0 +1,6 @@
+from fquery.pydantic import pydantic
+
+
+@pydantic
+class Text:
+    pass

schema_models/text_digital_document.py

@@ -0,0 +1,7 @@
+from schema_models.digital_document import DigitalDocument
+
+
+class TextDigitalDocument(DigitalDocument):
+    """
+    A file composed primarily of text.
+    """

schema_models/text_object.py

@@ -0,0 +1,7 @@
+from schema_models.media_object import MediaObject
+
+
+class TextObject(MediaObject):
+    """
+    A text file. The text can be unformatted or contain markup, html, etc.
+    """

schema_models/theater_event.py

@@ -0,0 +1,7 @@
+from schema_models.event import Event
+
+
+class TheaterEvent(Event):
+    """
+    Event type: Theater performance.
+    """

schema_models/theater_group.py

@@ -0,0 +1,7 @@
+from schema_models.performing_group import PerformingGroup
+
+
+class TheaterGroup(PerformingGroup):
+    """
+    A theater group or company, for example, the Royal Shakespeare Company or Druid Theatre.
+    """

schema_models/therapeutic_procedure.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.dose_schedule import DoseSchedule
+from schema_models.drug import Drug
+from schema_models.medical_entity import MedicalEntity
+from schema_models.medical_procedure import MedicalProcedure
+
+
+class TherapeuticProcedure(MedicalProcedure):
+    """
+    A medical procedure intended primarily for therapeutic purposes, aimed at improving a health condition.
+    """
+
+    doseSchedule: Optional[Union[DoseSchedule, List[DoseSchedule]]] = None
+    drug: Optional[Union[Drug, List[Drug]]] = None
+    adverseOutcome: Optional[Union[MedicalEntity, List[MedicalEntity]]] = None

schema_models/thesis.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+
+
+class Thesis(CreativeWork):
+    """
+    A thesis or dissertation document submitted in support of candidature for an academic degree or professional qualification.
+    """
+
+    inSupportOf: Optional[Union[str, List[str]]] = None

schema_models/thing.py

@@ -0,0 +1,41 @@
+from typing import List, Optional, Union
+
+from fquery.pydantic import pydantic
+from pydantic import HttpUrl
+
+
+@pydantic
+class Thing:
+    """
+    The most generic type of item.
+    """
+
+    subjectOf: Optional[
+        Union["CreativeWork", List["CreativeWork"], "Event", List["Event"]]
+    ] = None
+    alternateName: Optional[Union[str, List[str]]] = None
+    additionalType: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    sameAs: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    identifier: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            "PropertyValue",
+            List["PropertyValue"],
+        ]
+    ] = None
+    name: Optional[Union[str, List[str]]] = None
+    url: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    description: Optional[Union[str, List[str], "TextObject", List["TextObject"]]] = (
+        None
+    )
+    potentialAction: Optional[Union["Action", List["Action"]]] = None
+    image: Optional[
+        Union["ImageObject", List["ImageObject"], HttpUrl, List[HttpUrl]]
+    ] = None
+    disambiguatingDescription: Optional[Union[str, List[str]]] = None
+    mainEntityOfPage: Optional[
+        Union["CreativeWork", List["CreativeWork"], HttpUrl, List[HttpUrl]]
+    ] = None

schema_models/ticket.py

@@ -0,0 +1,35 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.seat import Seat
+
+
+class Ticket(Intangible):
+    """
+    Used to describe a ticket to an event, a flight, a bus ride, etc.
+    """
+
+    dateIssued: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    ticketToken: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    priceCurrency: Optional[Union[str, List[str]]] = None
+    issuedBy: Optional[Union[Organization, List[Organization]]] = None
+    ticketedSeat: Optional[Union[Seat, List[Seat]]] = None
+    ticketNumber: Optional[Union[str, List[str]]] = None
+    totalPrice: Optional[
+        Union[
+            str,
+            List[str],
+            "PriceSpecification",
+            List["PriceSpecification"],
+            float,
+            List[float],
+        ]
+    ] = None
+    underName: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None

schema_models/tie_action.py

@@ -0,0 +1,7 @@
+from schema_models.achieve_action import AchieveAction
+
+
+class TieAction(AchieveAction):
+    """
+    The act of reaching a draw in a competitive activity.
+    """

schema_models/tier_benefit_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class TierBenefitEnumeration(Enumeration):
+    """
+    An enumeration of possible benefits as part of a loyalty (members) program.
+    """

schema_models/time.py

@@ -0,0 +1,6 @@
+from fquery.pydantic import pydantic
+
+
+@pydantic
+class Time:
+    pass

schema_models/tip_action.py

@@ -0,0 +1,26 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.contact_point import ContactPoint
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.trade_action import TradeAction
+
+
+class TipAction(TradeAction):
+    """
+    The act of giving money voluntarily to a beneficiary in recognition of services rendered.
+    """
+
+    recipient: Optional[
+        Union[
+            Audience,
+            List[Audience],
+            ContactPoint,
+            List[ContactPoint],
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+        ]
+    ] = None

schema_models/tire_shop.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class TireShop(Store):
+    """
+    A tire shop.
+    """

schema_models/tourist_attraction.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.language import Language
+from schema_models.place import Place
+
+
+class TouristAttraction(Place):
+    """
+    A tourist attraction.  In principle any Thing can be a [[TouristAttraction]], from a [[Mountain]] and [[LandmarksOrHistoricalBuildings]] to a [[LocalBusiness]].  This Type can be used on its own to describe a general [[TouristAttraction]], or be used as an [[additionalType]] to add tourist attraction properties to any other type.  (See examples below)
+    """
+
+    touristType: Optional[Union[str, List[str], Audience, List[Audience]]] = None
+    availableLanguage: Optional[Union[str, List[str], Language, List[Language]]] = None

schema_models/tourist_destination.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.place import Place
+
+
+class TouristDestination(Place):
+    """
+    A tourist destination. In principle any [[Place]] can be a [[TouristDestination]] from a [[City]], Region or [[Country]] to an [[AmusementPark]] or [[Hotel]]. This Type can be used on its own to describe a general [[TouristDestination]], or be used as an [[additionalType]] to add tourist relevant properties to any other [[Place]].  A [[TouristDestination]] is defined as a [[Place]] that contains, or is colocated with, one or more [[TouristAttraction]]s, often linked by a similar theme or interest to a particular [[touristType]]. The [UNWTO](http://www2.unwto.org/) defines Destination (main destination of a tourism trip) as the place visited that is central to the decision to take the trip.
+      (See examples below.)
+    """
+
+    touristType: Optional[Union[str, List[str], Audience, List[Audience]]] = None
+    includesAttraction: Optional[
+        Union["TouristAttraction", List["TouristAttraction"]]
+    ] = None