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.



   .. 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