sbol3.constraint
================

.. py:module:: sbol3.constraint


Classes
-------

.. autoapisummary::

   sbol3.constraint.Constraint


Functions
---------

.. autoapisummary::

   sbol3.constraint.build_constraint


Module Contents
---------------

.. py:class:: Constraint(restriction: str, subject: Union[sbol3.Identified, str], object: Union[sbol3.Identified, str], *, name: str = None, description: str = None, derived_from: List[str] = None, generated_by: List[str] = None, measures: List[sbol3.SBOLObject] = None, identity: Optional[str] = None, type_uri: str = SBOL_CONSTRAINT)

   Bases: :py:obj:`sbol3.Identified`


   The Constraint class can be used to assert restrictions on the
   relationships of pairs of Feature objects contained by the same
   parent Component. Uses of this class include expressing
   containment (e.g., a plasmid transformed into a chassis strain),
   identity mappings (e.g., replacing a placeholder value with a
   complete definition), and expressing relative, sequence-based
   positions (e.g., the ordering of features within a template). Each
   Constraint includes the subject, object, and restriction
   properties.


   :param identity: this object's Uniform Resource Identifier (URI).
       this URI MUST be globally unique among all other Identified
       object URIs. See SBOL 3.0.1 specification section 5.1.
       This can also be a `displayId`, which will be concatenated
       to a default namespace automatically.
   :param type_uri: the concrete type of this object, specified as
       a URI. These are typically in the SBOL3 namespace, like
       `http://sbols.org/v3#Sequence` or
       `http://sbols.org/v3#Component`. This can also be the type
       URI of an extension class.
   :param name: A human-readable name for this object, for display
       purposes.
   :param description: Per the SBOL 3.0.1 specification, "a more
       thorough text description" of this object.
   :param derived_from: The URIs of one or more SBOL or non-SBOL
       objects from which this object was derived. This property
       is defined by the PROV-O ontology.
   :param generated_by: The URIs of one or more prov:Activity
       objects that describe how this object was generated. This
       property is defined by the PROV-O ontology.
   :param measures: The URIs of one or more om:Measure objects,
       each of which refers to a om:Measure object that describes
       measured parameters for this object. om:Measure objects are
       defined by the OM ontology


   .. py:method:: accept(visitor: Any) -> Any

      Invokes `visit_constraint` on `visitor` with `self` as the only
      argument.

      :param visitor: The visitor instance
      :type visitor: Any
      :raises AttributeError: If visitor lacks a visit_constraint method
      :return: Whatever `visitor.visit_constraint` returns
      :rtype: Any




   .. py:attribute:: object


   .. py:attribute:: restriction


   .. py:attribute:: subject


   .. py:method:: validate(report: ValidationReport = None) -> ValidationReport


.. py:function:: build_constraint(identity: str, type_uri: str = SBOL_CONSTRAINT) -> sbol3.SBOLObject