sbol3.property_base
===================

.. py:module:: sbol3.property_base


Classes
-------

.. autoapisummary::

   sbol3.property_base.ListProperty
   sbol3.property_base.Property
   sbol3.property_base.SingletonProperty


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

.. py:class:: ListProperty(property_owner: Any, property_uri: str, lower_bound: int, upper_bound: int, validation_rules: Optional[List] = None)

   Bases: :py:obj:`Property`, :py:obj:`collections.abc.MutableSequence`, :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: __contains__(item) -> bool


   .. py:method:: __delitem__(key: Union[int, slice]) -> None


   .. py:method:: __eq__(other) -> bool


   .. py:method:: __getitem__(key: Union[int, slice]) -> Any


   .. py:method:: __len__() -> int


   .. py:method:: __repr__() -> str


   .. py:method:: __setitem__(key: Union[int, slice], value: Any) -> None


   .. py:method:: __str__() -> str


   .. py:method:: insert(index: int, value: Any) -> None

      S.insert(index, value) -- insert value before index



   .. py:method:: set(value: Any) -> None


.. py:class:: Property(property_owner: Any, property_uri: str, lower_bound: int, upper_bound: int, validation_rules: Optional[List] = None)

   Bases: :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:property:: attribute_name
      :type: Union[str, None]


      Heuristically determine which attribute is associated with
      this property. If no attribute can be found for this property
      return None.



   .. py:method:: from_user(value: Any)
      :abstractmethod:



   .. py:method:: item_added(item: Any) -> None

      Stub method for child classes to override if they have to do
      any additional processing on items after they are added. This method
      will be called on each individual item that was added to the list.



   .. py:attribute:: lower_bound


   .. py:attribute:: property_owner


   .. py:attribute:: property_uri


   .. py:method:: set(value: Any) -> None
      :abstractmethod:



   .. py:method:: to_user(value: Any) -> str
      :abstractmethod:



   .. py:attribute:: upper_bound


   .. py:method:: validate(name: str, report: sbol3.ValidationReport)


   .. py:attribute:: validation_rules
      :value: None



.. py:class:: SingletonProperty(property_owner: Any, property_uri: str, lower_bound: int, upper_bound: int, validation_rules: Optional[List] = None)

   Bases: :py:obj:`Property`, :py:obj:`abc.ABC`


   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. py:method:: get() -> Any


   .. py:method:: set(value: Any) -> None