scml.scml2020.components.signing
================================

.. py:module:: scml.scml2020.components.signing


Classes
-------

.. autoapisummary::

   scml.scml2020.components.signing.SignAll
   scml.scml2020.components.signing.SignAllPossible
   scml.scml2020.components.signing.KeepOnlyGoodPrices


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

.. py:class:: SignAll

   Signs all contracts no matter what.

   Overrides:
       - `sign_all_contracts`

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.


   .. py:method:: sign_all_contracts(contracts: List[negmas.Contract]) -> List[Optional[str]]


.. py:class:: SignAllPossible

   Signs all contracts that can in principle be honored.
   The only check made by this strategy is that for sell contracts there is enough production capacity

   Overrides:
       - `sign_all_contracts`

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.


   .. py:method:: sign_all_contracts(contracts: List[negmas.Contract]) -> List[Optional[str]]


.. py:class:: KeepOnlyGoodPrices(*args, buying_margin=0.5, selling_margin=0.5, **kwargs)

   Signs all contracts that have good prices

   Overrides:
       - `sign_all_contracts`

   .. attribute:: - buying_margin

      The margin from the catalog price to allow for buying. The agent will never buy at a price
      higher than the catalog price by more than this margin (relative to catalog price).

   .. attribute:: - selling_margin

      The margin from the catalog price to allow for selling. The agent will never sell at a price
      lower than the catalog price by more than this margin (relative to catalog price).

   Remarks:
       - `Attributes` section describes the attributes that can be used to construct the component (passed to its
         `__init__` method).
       - `Provides` section describes the attributes (methods, properties, data-members) made available by this
         component directly. Note that everything provided by the bases of this components are also available to the
         agent (Check the `Bases` section above for all the bases of this component).
       - `Requires` section describes any requirements from the agent using this component. It defines a set of methods
         or properties/data-members that must exist in the agent that uses this component. These requirement are
         usually implemented as abstract methods in the component
       - `Abstract` section describes abstract methods that MUST be implemented by any descendant of this component.
       - `Hooks Into` section describes the methods this component overrides calling `super` () which allows other
         components to hook into the same method (by overriding it). Usually callbacks starting with `on_` are
         hooked into this way.
       - `Overrides` section describes the methods this component overrides without calling `super` effectively
         disallowing any other components after it in the MRO to call this method. Usually methods that do some
         action (i.e. not starting with `on_`) are overridden this way.


   .. py:method:: sign_all_contracts(contracts: List[negmas.Contract]) -> List[Optional[str]]