Skip to content

Instantly share code, notes, and snippets.

@tonyskapunk
Created October 5, 2018 16:28
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save tonyskapunk/0440271eed357fdd31befd476f017691 to your computer and use it in GitHub Desktop.
Save tonyskapunk/0440271eed357fdd31befd476f017691 to your computer and use it in GitHub Desktop.
pydoc for opsdroid
  • master:
Help on module memory:

NAME
    memory - Class for persisting information in opsdroid.

CLASSES
    builtins.object
        Memory
    
    class Memory(builtins.object)
     |  An object to store and persist data outside of opsdroid.
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      Create memory dictionary.
     |  
     |  get(self, key)
     |      Get data object for a given key.
     |  
     |  put(self, key, data)
     |      Put a data object to a given key.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FILE
    /home/tonyskapunk/me/github/opsdroid/opsdroid/memory.py
  • issue532_memory:
Help on module memory:

NAME
    memory - Class for persisting information in opsdroid.

CLASSES
    builtins.object
        Memory
    
    class Memory(builtins.object)
     |  A Memory object.
     |  
     |  An object to obtain, store and persist data outside of opsdroid.
     |  
     |  Attributes:
     |      databases (:obj:`list` of :obj:`Database`): List of database objects.
     |      memory (:obj:`dict`): In-memory dictionary to store data.
     |  
     |  Methods defined here:
     |  
     |  __init__(self)
     |      Create object with minimum properties.
     |  
     |  get(self, key)
     |      Get data object for a given key.
     |      
     |      Gets the key value found in-memory or from the database(s).
     |      
     |      Args:
     |          key (str): Key to retrieve data.
     |      
     |      Returns:
     |          A data object for the given key, otherwise `None`.
     |  
     |  put(self, key, data)
     |      Put a data object to a given key.
     |      
     |      Stores the key and value in memory and the database(s).
     |      
     |      Args:
     |          key (str): Key for the data to store.
     |          data (obj): Data object to store.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)

FILE
    /home/tonyskapunk/me/github/opsdroid/opsdroid/memory.py

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment