From 01a49a2421e226b66585ea5e503896d40afaf603 Mon Sep 17 00:00:00 2001
From: Vincent Pelletier <vincent@nexedi.com>
Date: Sat, 28 Aug 2010 08:27:45 +0000
Subject: [PATCH] Document _load .
git-svn-id: https://svn.erp5.org/repos/neo/trunk@2255 71dcc9de-d417-0410-9af5-da40c76e7ee4
---
neo/client/app.py | 30 +++++++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/neo/client/app.py b/neo/client/app.py
index fb96fdf8..d5220855 100644
--- a/neo/client/app.py
+++ b/neo/client/app.py
@@ -439,7 +439,35 @@ class Application(object):
@profiler_decorator
def _load(self, oid, serial=None, tid=None, cache=0):
- """Internal method which manage load ,loadSerial and loadBefore."""
+ """
+ Internal method which manage load, loadSerial and loadBefore.
+ OID and TID (serial) parameters are expected packed.
+ oid
+ OID of object to get.
+ serial
+ If given, the exact serial at which OID is desired.
+ tid should be None.
+ tid
+ If given, the excluded upper bound serial at which OID is desired.
+ serial should be None.
+ cache
+ Store data in cache for future lookups.
+
+ Return value: (3-tuple)
+ - Object data (None if object creation was undone).
+ - Serial of given data.
+ - Next serial at which object exists, or None. Only set when tid
+ parameter is not None.
+
+ Exceptions:
+ NEOStorageError
+ technical problem
+ NEOStorageNotFoundError
+ object exists but no data satisfies given parameters
+ object doesn't exist
+ """
+ # TODO:
+ # - rename parameters (here and in handlers & packet definitions)
cell_list = self._getCellListForOID(oid, readable=True)
if len(cell_list) == 0:
# No cells available, so why are we running ?
--
2.30.9