Download Install Tutorial Docs FAQ Tools WikiLicense Team IRC Planet Involvement Shop Book

Changeset 1696

Show
Ignore:
Timestamp:
07/09/07 16:31:51
Author:
fumanchu
Message:

Docstrings in lib/sessions.py

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/cherrypy/lib/sessions.py

    r1690 r1696  
    137137     
    138138    def pop(self, key, default=missing): 
     139        """Remove the specified key and return the corresponding value. 
     140        If key is not found, default is returned if given, 
     141        otherwise KeyError is raised. 
     142        """ 
    139143        if not self.loaded: self.load() 
    140144        if default is missing: 
     
    148152     
    149153    def has_key(self, key): 
     154        """D.has_key(k) -> True if D has a key k, else False.""" 
    150155        if not self.loaded: self.load() 
    151156        return self._data.has_key(key) 
    152157     
    153158    def get(self, key, default=None): 
     159        """D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.""" 
    154160        if not self.loaded: self.load() 
    155161        return self._data.get(key, default) 
    156162     
    157163    def update(self, d): 
     164        """D.update(E) -> None.  Update D from E: for k in E: D[k] = E[k].""" 
    158165        if not self.loaded: self.load() 
    159166        self._data.update(d) 
    160167     
    161168    def setdefault(self, key, default=None): 
     169        """D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D.""" 
    162170        if not self.loaded: self.load() 
    163171        return self._data.setdefault(key, default) 
    164172     
    165173    def clear(self): 
     174        """D.clear() -> None.  Remove all items from D.""" 
    166175        if not self.loaded: self.load() 
    167176        self._data.clear() 
    168177     
    169178    def keys(self): 
     179        """D.keys() -> list of D's keys.""" 
    170180        if not self.loaded: self.load() 
    171181        return self._data.keys() 
    172182     
    173183    def items(self): 
     184        """D.items() -> list of D's (key, value) pairs, as 2-tuples.""" 
    174185        if not self.loaded: self.load() 
    175186        return self._data.items() 
    176187     
    177188    def values(self): 
     189        """D.values() -> list of D's values.""" 
    178190        if not self.loaded: self.load() 
    179191        return self._data.values() 
     
    210222     
    211223    def acquire_lock(self): 
     224        """Acquire an exclusive lock on the currently-loaded session data.""" 
    212225        self.locked = True 
    213226        self.locks.setdefault(self.id, threading.RLock()).acquire() 
    214227     
    215228    def release_lock(self): 
     229        """Release the lock on the currently-loaded session data.""" 
    216230        self.locks[self.id].release() 
    217231        self.locked = False 
     
    230244     
    231245    def setup(self): 
     246        """Set up the storage system for file-based sessions. 
     247         
     248        This should only be called once per process; this will be done 
     249        automatically when using sessions.init (as the built-in Tool does). 
     250        """ 
    232251        # Warn if any lock files exist at startup. 
    233252        lockfiles = [fname for fname in os.listdir(self.storage_path) 
     
    271290     
    272291    def acquire_lock(self, path=None): 
     292        """Acquire an exclusive lock on the currently-loaded session data.""" 
    273293        if path is None: 
    274294            path = self._get_file_path() 
     
    285305     
    286306    def release_lock(self, path=None): 
     307        """Release the lock on the currently-loaded session data.""" 
    287308        if path is None: 
    288309            path = self._get_file_path() 
     
    357378    
    358379    def acquire_lock(self): 
     380        """Acquire an exclusive lock on the currently-loaded session data.""" 
    359381        # We use the "for update" clause to lock the row 
    360382        self.locked = True 
     
    363385     
    364386    def release_lock(self): 
     387        """Release the lock on the currently-loaded session data.""" 
    365388        # We just close the cursor and that will remove the lock 
    366389        #   introduced by the "for update" clause 

Hosted by WebFaction

Log in as guest/cpguest to create tickets