py1010
index

py1010: 1010data Insights Platform's Python SDK
 
py1010 enables making 1010data calls within Python and inspect the results
in a familiar, Python-like way. To create a new session and log in,
you can do something like:
 
   >>> import py1010
   >>> session=py1010.Session("http://www2.1010data.com/prod-latest/gw",                               "USERNAME", "PASSWORD", py1010.POSSESS)
 
The last parameter is for the login type, which determines what happens
when the application establishes a connection to the Insights Platform
and another session is currently active. The login types are: py1010.KILL,
py1010.NOKILL, or py1010.POSSESS.
 
For a group login, supply a group name after the login type parameter
(or with the "group=" keyword). py1010 acquires a userid and logs in.
 
You can create queries using the XML query language.
 
   >>> query=session.query("pub.demo.weather.hourly90",                            '<sort cols="date,hour,id"/>')
   >>> query.run()
 
The columns from the query are available as items or attributes of the
query, and the contents of each column are available by subscripting:
 
   >>> query['date'][0], query['temp'][0]
   (datetime.date(1990, 1, 1), -12.2)
 
Insights platform "date" data is automatically converted to python
datetime.date objects.
 
Most of the CSDK API is exposed through py1010; you may need to refer to
the CSDK documentation for further explanation of some of the calls.
Generally, in cases where the API function would return a non-zero value to
indicate an error, py1010 will throw a TentenException object.
 
In the docstrings of this module, an asterisk "(*)" generally means that the
documented method _may_ cause network access.
 
This module may be available for both Python2 and Python3. If you are
using Python3, many of the parameters and return values of the methods will
be "bytes" objects and not strings.

 
Modules
       
builtins
datetime
io
json
logging
math
os
ssl
sys
urllib
weakref

 
Classes
       
builtins.Exception(builtins.BaseException)
TentenException
DBMError
TentenClosedSessionException
TentenNotLastException
TentenNotRunException
TentenPoolFullException
TentenTransactionException
builtins.object
Holder
AWSKey
AddtableStatus
ColumnInfo
SourceColumnInfo
SourceFile
SourceSpec
SyncInfo
SourceInfo
TableInfo
TableSpec
OktaLogin
StructWrapper
TentenObject
BaseQuery
Query
Column
DirEntry
Directory
MetaData
RowIterator
Session

 
class AWSKey(Holder)
    AWSKey(name, key, id_, region, ptr=None, *)
Class holding AWS keys, wrapping CSDK AWSKEY structs.
 
 
Method resolution order:
AWSKey
Holder
builtins.object

Methods defined here:
__init__(...)
Constructor for AWSKey.
 
@param name A string (or bytes): the name by which the API will
refer to this key.
@param key A string/bytes containing the AWS "secret" key.
@param id_ A string/bytes containing the AWS id.
@param region A string/bytes containing the AWS region.
@param ptr For internal use only.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
AWSKey.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
AWSKey.__setstate_cython__(self, __pyx_state)
__str__(self, /)
Return str(self).

Data descriptors defined here:
id
The AWS key id.
key
The "secret" AWS key.
name
The name by which the system knows this key.
region
The AWS region for this key.

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class AddtableStatus(Holder)
    AddtableStatus(ptr=None)
Status of an ongoing (asynchronous) Addtable transaction.
 
    The status property is given in terms of the AddtableStatus.Status
    enumeration, viz:
 
        AddtableStatus.Status.IDLE          (0)
        AddtableStatus.Status.FAILED        (1)
        AddtableStatus.Status.INITIALIZING  (2)
        AddtableStatus.Status.LOADING       (3)
        AddtableStatus.Status.COMPLETED     (4)
        AddtableStatus.Status.DIAGNOSED     (5)
 
    Properties:
        tablepath       Name of table being uploaded to
        status          Status of transaction (see above)
        totalRecs       Number of records uploaded so far (or total)
        expectedBytes   Number of bytes expected, if known
        filteredBytes   Bytes filtered out by autocorrection
        skippedBytes    Bytes skipped (not filtered)
        message         Status message from server
        targets         Location (a SourceInfo object) where filtered bytes
                        are written
 
 
Method resolution order:
AddtableStatus
Holder
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
AddtableStatus.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
AddtableStatus.__setstate_cython__(self, __pyx_state)

Data descriptors defined here:
expectedBytes
Expected bytes to be uploaded.
filteredBytes
Number of bytes filtered out by autocorrection.
message
Status message returned by server.
skippedBytes
Number of bytes skipped.
status
Status of the transaction:
 
AddtableStatus.Status.IDLE          (0)
AddtableStatus.Status.FAILED        (1)
AddtableStatus.Status.INITIALIZING  (2)
AddtableStatus.Status.LOADING       (3)
AddtableStatus.Status.COMPLETED     (4)
AddtableStatus.Status.DIAGNOSED     (5)
tablepath
Full path name of table being uploaded.
targets
SourceInfo object describing file where filtered bytes
are written.
totalBytes
Total number of bytes uploaded (so far).
totalRecs
Total number of records uploaded (so far).

Data and other attributes defined here:
Status = <enum 'Status'>
An enumeration.
__pyx_vtable__ = <capsule object NULL>

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class BaseQuery(TentenObject)
    BaseQuery(table, xml)
Base class for Query objects, not bound to sessions.
 
    These objects basically contain only table and ops information, and
    cannot be run (as they have no session associated with them).  They are
    used in pool-warming.
 
    Properties:
        table   Name of the base table of this query
        xml             The XML of the operations for this query.
 
 
Method resolution order:
BaseQuery
TentenObject
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
BaseQuery.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
BaseQuery.__setstate_cython__(self, __pyx_state)

Data descriptors defined here:
table
xml

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class Column(TentenObject)
    Column(query, magic)
Represents a tenten column. This is created by Query objects
    when they are run(). Column objects can be accessed as lists (though
    potentially very large ones) by subscripting (including ranges) or using
    iterators.  Data is automatically fetched at need in 'windows' of size
    win_size (only one window is in memory at a given time for each row).
 
    Properties:
       name             Column name
       type             Column type ('a', 'i', 'j', or 'f')
       format           Format string
       nrows            Number of rows in query
       win_size         The win_size of the query associated with this column
       colwin_start     The start of the current window of data for this column
       colwin_end       The end of the current window of data for this column
       ktype            K type of the column (integer)
       title            Column title
       width            Width field of format string (integer; 0 if not given)
       format_dict      The format of the column as a dictionary
       format_type      Type field of format string (None if not given)
       dec              Dec field of format string (integer; -1 if not given)
       rawValues        Handle infinity and NA values in integer columns,
                        as described for the rawValues property of the Query
                        class.  If None (the default), use the value set for
                        this column's Query.  Otherwise, override it for this
                        column.
 
 
Method resolution order:
Column
TentenObject
builtins.object

Methods defined here:
__getitem__(...)
The value of the column at the given row.
If the row is not currently available for this column,
it is fetched. (*)
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__iter__(self, /)
Implement iter(self).
__len__(self, /)
Return len(self).
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Column.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
Column.__setstate_cython__(self, __pyx_state)
__str__(self, /)
Return str(self).
fetchrows(self, *args, **kwargs)
Column.fetchrows(self, starting=None)
Fetches a window of rows. Users should not need to call this. (*)
format_value(self, *args, **kwargs)
Column.format_value(self, index)
Formats the value at the given index according to the column's
        formatting, for dates and times. (*)
get(...)
Column.get(self, n, raw=False)
The value of the column at the given row.  If the row is not
        currently available for this column, it is fetched.  The
        parameter "raw" controls translating dates, infinities, model
        columns, etc.  If raw=False (default), values are converted to
        Python objects.  If raw=True, no conversion is done.  If
        raw="safe", conversion is done, unless the conversion results in
        an exception, in which case the raw value is returned.
        Note that self.rawValues is respected when raw is not True. Use
        raw=True to override self.rawValues for this particular value. (*)
getlocal(...)
Column.getlocal(self, n)
This is the same as column[n], except that it raises an IndexError
        if the value is not available in the currently-loaded window.
has(...)
Column.has(self, n)
Checks the given index within the window of values currently loaded
        for this column.

Data descriptors defined here:
colwin_end
colwin_start
dec
Decimal places specified in the format, or -1 (int(self.format_dict.get('dec', -1)))
format
Column format string
format_dict
format_type
Format type (self.format_dict.get('type',""))
ktype
The K type of this column
name
Column name
nrows
Total number of rows
query
rawValues
rawValues: object
title
Column title (*)
type
Column type (a, i, j, or f)
width
Column format width (int(self.format_dict.get('width',0)))
win_size
The win_size of the query associated with this column

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class ColumnInfo(Holder)
    ColumnInfo(name, type_, title=None, desc=None, format=None, int index=Index.NOINDEX, int fix=Fix.NOFIX, ptr=None, *)
Class for holding metadata about a column being uploaded into.
 
 
Method resolution order:
ColumnInfo
Holder
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
ColumnInfo.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
ColumnInfo.__setstate_cython__(self, __pyx_state)
fromSourceCol(...) from builtins.type
ColumnInfo.fromSourceCol(type cls, scol)
Translate a SourceColumnInfo into a ColumnInfo by copying over
        some key fields.
init(...)
ColumnInfo.init(self, name, type_, title=None, desc=None, format=None, int index=Index.NOINDEX, int fix=Fix.NOFIX)

Data descriptors defined here:
desc
Description of the column
fix
format
Format of the column.
index
name
Name of the column
title
Title of the column, displayed when the table is viewed.
type
Type of the column ("integer", "yyyymmdd", etc.)

Data and other attributes defined here:
Fix = <enum 'Index'>
An enumeration.
Index = <enum 'Index'>
An enumeration.
__pyx_vtable__ = <capsule object NULL>

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class DBMError(TentenException)
    Exception raised when a DBM transaction fails.
 
 
Method resolution order:
DBMError
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class DirEntry(TentenObject)
    DirEntry(session, magic)
A wrapper for the directory entry C structure that should only be created
    internally.
 
    Properties:
       type             0 for directory, 1 for table
       id               id of this object
       name             file/directory name
       title            title of object
       sdesc            short description
       ldesc            long description
       owner            owner of this object
       update           last update timestamp
       secure           if 1, object only accessible via SSL connection
 
 
Method resolution order:
DirEntry
TentenObject
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
DirEntry.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
DirEntry.__setstate_cython__(self, __pyx_state)
__str__(self, /)
Return str(self).
asdict(...)
DirEntry.asdict(self)
The information on this object as a dictionary.
metaInfo(self, *args, **kwargs)
DirEntry.metaInfo(self)
Gets the MetaData for this directory entry (*)
setMetaInfo(self, *args, **kwargs)
DirEntry.setMetaInfo(self, MetaData meta, flags=-1)
Sets the MetaData on this directory entry (*)

Data descriptors defined here:
id
ID of this object
ldesc
Long description
name
File or directory name
owner
The object's owner
sdesc
Short description
secure
title
Title of this object
type
Type of entry: 0 for directory and 1 for table(?)
update
Update timestamp, as a datetime object

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class Directory(DirEntry)
    Directory(Session session, magic)
Represents a directory in the 1010 file tree. You should not create
    these directly; use the fromPath() static method instead, or call
    directory() on a Session object.
 
 
Method resolution order:
Directory
DirEntry
TentenObject
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Directory.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Directory.__setstate_cython__(self, __pyx_state)
children(self, *args, **kwargs)
Directory.children(self)
Iterates over the children of this directory (as DirEntry objects). (*)
parents(self, *args, **kwargs)
Directory.parents(self)
Iterates over the parents of this directory (as DirEntry objects). (*)

Static methods defined here:
createDirectory(...)
Directory.createDirectory(session, pathname, title=None, users=None, uploaders=None, inherit_users=False, inherit_uploaders=False)
Creates a directory from a pathname.
fromPath(...)
Directory.fromPath(session, pathname)
Finds a directory from its pathname. You must supply a valid Session. (*)
removeDirectory(...)
Directory.removeDirectory(Session session, pathname)
Removes a directory given the pathname.

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from DirEntry:
__repr__(self, /)
Return repr(self).
__str__(self, /)
Return str(self).
asdict(...)
DirEntry.asdict(self)
The information on this object as a dictionary.
metaInfo(self, *args, **kwargs)
DirEntry.metaInfo(self)
Gets the MetaData for this directory entry (*)
setMetaInfo(self, *args, **kwargs)
DirEntry.setMetaInfo(self, MetaData meta, flags=-1)
Sets the MetaData on this directory entry (*)

Data descriptors inherited from DirEntry:
id
ID of this object
ldesc
Long description
name
File or directory name
owner
The object's owner
sdesc
Short description
secure
title
Title of this object
type
Type of entry: 0 for directory and 1 for table(?)
update
Update timestamp, as a datetime object

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class Holder(builtins.object)
    Holder(magic, size, ptr=None, *)
 
Parent class for classes that will wrap a C struct.
 
Contains a StructWrapper which does the actual wrapping.
 
  Methods defined here:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__init__(...)
Superclass constructor for Holder.
 
@param magic The magic number you have to know to use this.
@param size The size of the structure to be wrapped.
@param ptr A PyCapsule holding a pointer to a C struct to be wrapped.
If None (not supplied), allocate a new one.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Holder.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Holder.__setstate_cython__(self, __pyx_state)

Data descriptors defined here:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes defined here:
__hash__ = None

 
class MetaData(TentenObject)
    MetaData(session, magic)
Contains metadata for objects in the 1010 directory system.  These
    are returned by the metaInfo method on directory entry objects.
    Various attributes of the metadata object are configurable, and they
    can be altered and used in setMetaInfo(), which changes the metadata on
    the file entry.  Note: changing the values on the metadata object does
    *not* alter the actual values on the server, until setMetaInfo() is
    called.
 
    This class is not meant to be used directly; either use the metaInfo()
    method on a DirEntry object or use the fromPath() class method.
 
    Properties:
       id               Object's id in 1010 system
       path             Path-name in 1010 filetree
       title    Object's title
       sdesc    Short description
       ldesc    Long description
       type             Item type ("REAL", "DIR", etc)
       secure
       own
       owner    Item's owner
       update   Timestamp of last update
       favorite
       users    Users authorized to access this object
       display
       report
       chart
       link             Link description
       rows             Number of rows (if a table)
       bytes    Size of item (in bytes)
       segs             Number of segments
       tstat
       access
       maxdown  Maximum number of rows permitted per download
       upload
       uploaders
       numchild
       segby
       keys
 
 
Method resolution order:
MetaData
TentenObject
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
MetaData.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
MetaData.__setstate_cython__(self, __pyx_state)
asdict(...)
MetaData.asdict(self)
The metadata in dictionary form.
fromPath(...) from builtins.type
MetaData.fromPath(type cls, Session session, path)
Fetch the metadata for the named table or directory.  You should
        not, in general, be using this; you should get MetaData objects from
        directory entry objects. (*)

Data descriptors defined here:
access
bytes
size of the item (in bytes)
chart
display
favorite
id
Object's id in the 1010 system.
keys
ldesc
Long description.
link
link description.
maxdown
maximum number of rows permitted per download
numchild
own
owner
Item's owner
path
Path (directories and filename)
report
rows
number of rows (for a table)
sdesc
Short description
secure
segby
segs
number of segments
title
Item's title.
tstat
type
Item type.
update
Timestamp of item's last update.
upload
uploaders
users
Users are authorized to access this object.

Data and other attributes defined here:
ACCESS = 262144
ALL = -1
BYTES = 32768
CHART = 4096
DISPLAY = 1024
FAVORITE = 256
KEYS = 2097152
LDESC = 4
LINK = 8192
MAXDOWN = 524288
OWN = 32
OWNER = 64
REPORT = 2048
ROWS = 16384
SDESC = 2
SECURE = 16
SEGS = 65536
SEGTYPE = 1048576
TITLE = 1
TSTAT = 131072
TYPE = 8
UPDATE = 128
USERS = 512
__pyx_vtable__ = <capsule object NULL>

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class OktaLogin(builtins.object)
    OktaLogin(email, password, gusurl=u'http://gus.1010data.com')
 
Used by Session in order to login using okta credentials.
 
This object can be passed to Session in the constructor or a new
Session could be created by calling getSession.  This object fetches
the okta token and the available environments for the user account.  A
new okta token and environment list are fetched from GUS, and all the
environment information is available under the environments property.
Using a different environment other the default one is done by changing
the chosenEnvId property.  Changing the environment version is done by
changing the chosenVersion property.
 
  Methods defined here:
__init__(...)
Create OktaLogin object
:param str email: The user email
:param str password: User pasword
:param str gusurl: The GUS url to fetch the okta token from
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
OktaLogin.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
OktaLogin.__setstate_cython__(self, __pyx_state)
getSession(...)
OktaLogin.getSession(self, logintype)
 
Get new Session initializied with this OktaLogin object.
:param logintype: KILL, NOKILL, or POSSESS
sessionLogin(...)
OktaLogin.sessionLogin(self, logintype, Session session)

Data descriptors defined here:
chosenEnvId
chosenVersion
environments

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

 
class Query(BaseQuery)
    Query(session, table, xml=u'')
Representing 1010data Insights Platform queries and their result sets.
 
    Created with the ".query()" method on Session objects. It
    specifies the table the query operates on and the query's XML.
    Before accessing the results of a query, the query's ".run()" method
    must be executed. This creates the Column objects that hold the
    result set and populates the query's coldict and cols attributes.
 
    The columns are accessible through the query by subscripting with
    column names. A column named "transaction" can be accessed as
    "query['transaction']". Columns are *also* accessible as attributes of
    the query object, so "query.transaction" works.
 
    If you have names that are already used for members of the class or are
    Python reserved words, you must use subscripting.
 
    Accessing some methods or properties of a Query object before that
    query is run raises a TentenNotRunException. The relevant
    properties are marked with (-) in the list below.
 
    Properties:
       nrows            Number of rows in the result set (-)
       win_start        Index of starting point of last-fetched window of data (-)
       win_end          Index of end point of last-fetched window of data (-)
       win_size         Size of window to be downloaded (configurable)
       title            Title of the base table of this query (-)
       sdesc            Short description of the base table of this query (-)
       ldesc            Long description of the base table of this query (-)
       messagetext      Last message text from the 1010data Insights Platform session
       table            Name of the base table of this query
       session          The Session object for this query
       cols             A list of the columns. (-)
       coldict          An ordered dictionary of columns indexed by name (-)
       lastrun          A datetime object of when this query was last run.
       rows             A new row iterator object each time accessed. (-)
       xml              The XML of the operations for this query.
       transfermode     The transfer mode (raw, (un)compressed, etc) of the query.
       rawValues        If True, use the raw (internal) values for infinity and NA
                        values in integer (and 64bit-integer) columns.  If False (the
                        default), return float('inf') or float('-inf') for infinities,
                        and float('NaN') for NA values.
 
 
Method resolution order:
Query
BaseQuery
TentenObject
builtins.object

Methods defined here:
__bool__(self, /)
self != 0
__dir__(...)
Query.__dir__(self)
__getattr__(...)
Same as colbyname(x), but only called if x does not otherwise match
an element of the Query object.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(...)
Equivalent to colbyname(x)
__init__(...)
Create a query with the given session URL, table, and xml ops.
Usually be called by session.query(...), you shouldn't
need to call it directly.
__iter__(...)
Iterate over the columns of this query.
__len__(...)
Number of columns in result
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Query.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Query.__setstate_cython__(self, __pyx_state)
__str__(self, /)
Return str(self).
colbyname(...)
Query.colbyname(self, name)
Find column in this query by name.
dictslice(...)
Query.dictslice(self, start, stop, step=1)
Return an ordered dictionary of lists, the dictionary indexed on
        the names of the columns of the Query and the lists being slices of
        the columns.
 
        >>> query.dictslice(start, stop, step)
 
        is equivalent to
 
        >>> {k : list(v[start:stop:step]) for k, v in query.coldict.items()}
 
        (Except it uses an OrderedDict)
 
        Note that this instantiates lists, not iterators, so all the data
        called for is downloaded and stored in memory.  Make sure the data
        size is small enough to fit in memory when calling this. (*)
expand(self, *args, **kwargs)
Query.expand(self, bufsize=20000)
Returns the expanded XML query. Optional parameter is
        the size of the buffer (default 20000). Use a larger buffer if it
        is too small. (*)
formatted_row(...)
Query.formatted_row(self, index)
A list of the values of all the columns at the given index, each
        one is formatted according to the format of that column. (*)
freshen(self, *args, **kwargs)
Query.freshen(self)
Call tenten_Freshen() to refresh the state of the table(s). (*)
getrow(...)
Query.getrow(self, n)
Row at a given index (i.e. a list of the values in all the
        columns at that index). (*)
has(...)
Query.has(self, n)
This is computed with respect to the _last_ read made for this
        query, regardless of the column. It probably is not the method you were
        looking for.
resave(...)
Query.resave(self, querypath, title=u'', sdesc=u'', ldesc=u'', users=None, inherit_users=False, owner=u'')
Replace the Quick Query with this new version. (*)
rowasdict(...)
Query.rowasdict(self, n)
Row at given index, presented as an ordered dictionary. (*)
rowiterator(...)
Query.rowiterator(self, *args)
Iterate over the rows of this query.  Arguments may be integers
        or strings, which are used to specify columns of the
        query (as index or colbyname). If none are specified, it's taken to
        mean _all_ the columns, in index order.  The iterator returns a
        tuple of the values of all the specified columns, in the specified
        order.
 
        This iterator is distinct and separate from ordinary access to the
        columns, and pulls down all the named columns together, instead of
        making a separate call for each column, so it will be more
        efficient if accessing a table row by row.
run(self, *args, **kwargs)
Query.run(self)
Execute query.  Must be done before data can be accessed. (*)
save(...)
Query.save(self, querypath, title=u'', sdesc=u'', ldesc=u'', force=False, users=None, inherit_users=False, owner=u'')
Save this query as a Quick Query (*).
        Pass in force=True to write a new query *or* replace an existing
        one of the same name, if the first write fails.
saveFile(self, *args, **kwargs)
Query.saveFile(self, dest, targettype, names=False, headers=False)
Save the results of a query to a file on FTP or S3.
 
        @param dest A SourceInfo object with a single SourceFile in it,
        or a string, which is converted to one.
        @param targettype A string (or bytes) specifying the format to
        save, currently one of "csv", "xlsx", "pdf", or "tde".
        @param names Use first row as column names? (default False)
        @param headers Use first (or second) row as column headers?
               (default False)
saveTableMaterialize(self, *args, **kwargs)
Query.saveTableMaterialize(self, *args, **kwargs)
Call saveTableMaterialize on the Session object; raise
        an Exception if this Query is not the 'current' one which
        would be saved.
saveToFTP(self, *args, **kwargs)
Query.saveToFTP(self, filename, sep=u'|', linesep=u'\n', namerow=False, headrow=False, compression=u'zip')
Save this query to FTP.  If namerow is True, first row will be
        taken to be column names. If headrow is True, first row (or second
        if namerow is also True) will be taken as column headers. (*)

Data descriptors defined here:
coldict
cols
cursor
Current index
lastrun
ldesc
Short description of the base table of this query. (*)
messagetext
This is the session's message text, which is filled in by CSDK
layer, and serves as some documentation of the status of the
last operation performed.
modelcols
Retrieve "model-type" columns as dictionaries ('True'), or do
not perform the complex calculation and the columns will just
contain the word "MODEL" ('False', default)
nrows
Total number of rows in the result
rawValues
rawValues: object
rows
Returns a RowIterator that iterates over the rows of the query. This is
exactly the same as query.rowiterator().  Note: a new
RowIterator is created for each access of this property.
sdesc
Short description of the base table of this query (*)
title
Title of the base table of this query (*)
transfermode
Get the transfer mode (compressed, binary, etc) for this query.
win_end
The index of the end point of the currently loaded window (last fetch).
win_size
The size of window to download (configurable)
Note: you can change win_size after reading in some values,
so win_start+win_size does not
necessarily equal win_end.
win_start
The index of the starting point of the currently loaded window (last fetch)

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Data descriptors inherited from BaseQuery:
table
xml

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class RowIterator(TentenObject)
    RowIterator(query, cols, start=0, stop=None, step=1)
An object that represents a generator that yields rows, or
    multi-column tuples, of successive indexes through the query. It
    shares the columns with the query. Accessing the columns outside of
    the iterator at indices outside of the iterator's current window may
    cause performance issues.
 
 
Method resolution order:
RowIterator
TentenObject
builtins.object

Methods defined here:
__getitem__(...)
Allows direct indexing into iterator, returning a tuple of the
iterator's columns at the given index.  This is the same as
getrow(ind) when used with an integer index, but it can also be
used with a python slice, in which case it returns a new
RowIterator covering just that slice.
 
Users should not use this function (with an integer index) on an
iterator that will be used later, as that would lose its place, but
it is safe to use in an expression like query.rows[5000], because
each access to query.rows returns a new iterator. (*)
__init__(...)
Creates a row iterator for the named query, starting at the given
index (default zero); the rest of the arguments specify the
columns, either by name or by index.
__iter__(self, /)
Implement iter(self).
__len__(...)
The length of the iterator. This is the length of the whole, not the
length of the remaining part.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__next__(...)
__reduce__ = __reduce_cython__(...)
RowIterator.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
RowIterator.__setstate_cython__(self, __pyx_state)
fetchrows(self, *args, **kwargs)
RowIterator.fetchrows(self, starting=None)
Fetches a window of rows. Users should not need to call this. (*)
getrow(...)
RowIterator.getrow(self, n)
Returns a tuple of the elements in this iterator's columns at a
        given index. If the index is not available from the relevant rows,
        it fetches the window of rows.  Users should not be
        calling this, but should be using next(). (*)
has(...)
RowIterator.has(self, n)
Reflects the given index within the window of values currently loaded
        by this iterator. This checks the windows of all the
        columns in the iterator to make sure the index is available for all
        of them. Columns may have different windows or may be
        accessed outside the iterator.

Data descriptors defined here:
arglist
index
qcols
query
start
step
stop

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class Session(TentenObject)
    Session(url, username, password, logintype, group=None, retry=1073741824, wait=10, logfile=None, mode=u'w', oktadesc=None, **kwargs)
Object representing a 1010 session.  Create with 1010 URL, username
    (or group ownername), password, and type of login (py1010.KILL,
    py1010.NOKILL, or py1010.POSSESS).  If this is a SAM pool (group) login, add
    another parameter for the groupID. py1010 automatically acquires a
    UID and logs in with it.
 
    Attempting to use a closed session, either directly or indirectly by
    using a Query that was created for it, raises a
    TentenClosedSessionException.
 
    Properties: (default value in parens. (w) means the value is writable,
    and (w-) means the value is writable but not readable)):
 
       messagetext      Last message text from 1010 API
       rc               Return code (int) of last operation performed
       timeout          Timeout parameter tuple: (connectTimeout, timeout) (w)
       reuseConnection  Reuse the same connection (True) (w-)
       lenient          Treat non-conforming columns leniently (False) (w-)
       ignoreSSLErrors  No exception on SSL errors (False) (w-)
       APIversion       API version of this session (w)
       systemVersion    System version this session is logged into
       lastResponse     Last response from the session
       transactions     Raw bitmask of available transactions
 
 
Method resolution order:
Session
TentenObject
builtins.object

Methods defined here:
__enter__(...)
Session.__enter__(self)
__exit__(...)
Session.__exit__(self, *args, **kwargs)
Close session on __exit__
__init__(...)
Create or connect to a 1010 session, supplying the URL, username
(or owner name for SAM Pool login), password, login type
(py1010.KILL, py1010.NOKILL, or py1010.POSSESS), and group name (for SAM
pool login). For SAM pool logins, a maximum number of retries
and the number of seconds to wait between retries can also be
specified (silently increased if below the minimum of 10s) (*)
 
You can also create a Session object _without logging in_ if
you have the SessionID (SID) and the Encrypted Password (EPW)
of an existing 1010data session.  Pass in the url and username,
and pass in the EPW as the password.  Use py1010.POSSESS as the
logintype, and add the keyword-only parameter "sid=SID" to pass
in the session ID.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Session.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Session.__setstate_cython__(self, __pyx_state)
__str__(self, /)
Return str(self).
addKey(self, *args, **kwargs)
Session.addKey(self, keyobj, key=u'', id_=u'', region=u'')
Add a key to the server-side keystore.
 
        Add a new AWS key to the keystore under a user-chosen name.
 
        @param keyobj The AWSKey object to add
 
        *OR* you can run with just the information for creating the
        AWSKey object and the function will construct it for you
 
        @param keyobj The user-defined name (a string) for the key.
        @param key The AWS secret key.
        @param id_ The AWS id.
        @param region The AWS region.
        @throws TentenTransactionException if a key with this name already
                exists in the keystore (among other reasons.)
addTable(self, *args, **kwargs)
Session.addTable(self, spec, sync=False)
Add a table from data already uploaded to FTP account.  Returns
        the name of the table.
addTableSpecs(...)
Session.addTableSpecs(self, sourcespec, tablespec, sync=False)
Add a table using given specifications.
 
        Runs the API's addtable transaction.
 
        @param sourcespec A SourceSpec object giving the location and
        structure of the source file(s) and the columns therein.
 
        @param tablespec A TableSpec object giving the name and other
        metadata for the target table, as well as the columns there.  If no
        columns are supplied here, the table column information will be
        copied from the source column information.
addTableStatus(self, *args, **kwargs)
Session.addTableStatus(self)
Check the status of an asynchronous upload with addTable()
 
        Returns a tuple (status, numrecs).  The status is an
        integer with the following meanings:
 
        0 - TENTEN_ADDTAB_IDLE
        1 - TENTEN_ADDTAB_FAILED
        2 - TENTEN_ADDTAB_INITIALIZING
        3 - TENTEN_ADDTAB_LOADING
        4 - TENTEN_ADDTAB_COMPLETED
        5 - TENTEN_ADDTAB_DIAGNOSED
 
        The numrecs is the number of records (rows) uploaded so far (or in
        total if the upload is complete).
addTableStatusList(...)
Session.addTableStatusList(self)
Get a list of the status of addtable transactions.
 
        @return A list of AddtableStatus objects for all of the addtable
        transactions that have been started so far in this session.
api2(...)
Session.api2(self, method, data=None, *, form=u'json', ignoreJSONErrors=False)
 
Call the QuickApp API.
 
@param method The API (QuickApp) to call.
@param data If given, call with be POST with this data (json-encoded)
@param form (keyword-only) Request the data in a given format.
       Default is "json"; other options may include "html" or
       "text"; the actual possibilities are determined by the
       server-side code.
@param ignoreJSONErrors (keyword-only) If json.loads (or
       decode('utf-8')) fails to decode the response, if this
       parameter is True, just return the response data instead of
       raising an exception
@returns Decoded json, or plain bytes from server if form is not
       "json".  If form is "json" and ignoreJSONErrors is True,
       returns the decoded json unless there is an error either
       in decoding the bytes to a string or in decoding the json,
       in which case it returns the plain bytes.
authenticateCredentials(...) from builtins.type
Session.authenticateCredentials(type cls, url, user, password)
Checks that the given credentials are valid. This does not require an
        open session (class method) and does not create one. This returns True
        if the credentials are *valid*.(*)
autoSpec(...)
Session.autoSpec(self, data)
Run the API's autospecfromdata transaction on the given data.
 
        Returns a dictionary of sourcefile information, with the source
        columns as dictionaries in a list under 'columns'.
 
        The {#autoSpecFile} method below is probably superior in most
        situations.
autoSpecFile(...)
Session.autoSpecFile(self, spec=None)
Run the API's autospec transaction on the source information
        provided.
 
        @param spec A SourceSpec object, or something that can be converted
        into one (a string or list of strings, a SourceFile object or list
        of SourceFiles, or a SourceInfo).  It may also contain source
        columns and other information to be used as "hints" by the
        auto-spec.
clearCache(self, *args, **kwargs)
Session.clearCache(self)
Clears the 1010data cache. (*)
close(self, *args, **kwargs)
Session.close(self)
Close the session and release userID if necessary.  Closed
        sessions can no longer be accessed for most purposes; attempting to
        do so raises a TentenClosedSessionException.
createDirectory(...)
Session.createDirectory(self, pathname, title=None, users=None, uploaders=None, inherit_users=False, inherit_uploaders=False)
dbm(...)
Session.dbm(self, trans, **kw)
 
Call the 'dbm' API2 endpoint.
 
@param trans The dbm transaction to invoke
@param kw Key-value arguments for the given transaction
@returns The transaction's response, decoded from json
debugAccum(...)
Session.debugAccum(self, on=True)
Switch ACCUM (server) into (or out of) Debug mode.
delKey(self, *args, **kwargs)
Session.delKey(self, keyobj, key=u'', id_=u'', region=u'')
Remove a key from the server-side keystore.
 
        Remove an AWS key in the keystore, specified by name.
 
        @param keyobj The AWSKey object containing the name of the
               key you want to remove.  The other information in the
               object is ignored.
 
        *OR* you can run with just the information for creating the
        AWSKey object and the function will construct it for you
 
        @param keyobj The user-defined name (a string) for the key.
        @param key (optional, ignored)
        @param id_ (optional, ignored)
        @param region (optional, ignored)
        @throws TentenTransactionException if a key with this name does
                not already exist in the keystore (among other reasons.)
directory(...)
Session.directory(self, dirname)
Returns a Directory object describing the directory named (*)
disableLog(self, *args, **kwargs)
Session.disableLog(self)
Disables XML logging
dropTable(self, *args, **kwargs)
Session.dropTable(self, table)
Deletes a table (*)
enableLog(self, *args, **kwargs)
Session.enableLog(self, filename=u'log.log', mode=u'a')
Enables XML logging
getRetry(self, *args, **kwargs)
Session.getRetry(self)
Gets retry parameters and returns a tuple:
        (retryMax, retryTimeMin, retryTimeRange, retryBase)
getUID(...) from builtins.type
Session.getUID(type cls, url, owner, password, group)
DEBUG ONLY: acquire a UID from a group.  Leaves UID unused,
        claimed, and unreleasable!
logRawXML(self, *args, **kwargs)
Session.logRawXML(self)
Enables raw XML logging
memUsage(self, *args, **kwargs)
Session.memUsage(self)
Returns the memory usage of the session, in bytes (*)
mergeTablesMaterialize(self, *args, **kwargs)
Session.mergeTablesMaterialize(self, tablelist, destpath, title=u'', sdesc=u'', ldesc=u'', link=u'', int maxdown=-1, int replace=False, users=None, char *segmentation=NULL, int sortseg=False, segbyAdvise=None, sortsegAdvise=None, int timeSeries=False, links=None, char *sort=NULL, *, inherit_users=False)
Merges a list of tables.  Runs the CSDK
        tenten_MergeTablesMaterialize function.
        This saves the most recently-run Query. (*)
 
        @param tablelist List of table-names to be merged
        @param destpath Path in the 1010 object tree to save this table.
        @param title Title of the table (default "")
        @param sdesc Short description (default "")
        @param ldesc Long description (default "")
        @param link String to be prepended to titles of linked columns
                (default "")
        @param maxdown Maximum number of cells that can be downloaded at once.
                Default -1, for no limit
        @param replace Replace the table if it already exists (default False)
        @param users List of usernames with access (default None)
        @param segmentation Comma-separated string, a list of columns to
                segment on (Default None)
        @param sortseg Use SortSeg (True) or SegBy (False, default)
        @param segbyAdvise List of comma-separated column-name sequences
                which can be assumed to be segmented with SegBy segmentation
                if segmentation is performed (Default None)
        @param sortsegAdvise List of comma-separated column-name sequences
                which can be assumed to be segmented with SortSeg segmentation
                if segmentation is performed (Default None)
        @param timeSeries Generate time-series metadata (default False)
        @param links A list of 1010 link ops (default None)
        @param sort Comma-separated string, a list of columns by which to
                sort the contents of each segment (default None)
        @param inherit_users (keyword-only): If True, ignore the list of users
                given (if any) and set the user permissions to 'inherit'.
moveTable(self, *args, **kwargs)
Session.moveTable(self, oldpath, newpath)
Moves a table from one pathname to another (*)
peekOnce(...)
Session.peekOnce(self, key, mode)
Get the value of a server-side variable
 
        @param key Content of <peek> tag to send to server
        @param mode Value of attribute <peek mode> to send to server
        @returns Value of the variable (bytes)
ptr(...)
Session.ptr(self, char *name=NULL)
putKey(self, *args, **kwargs)
Session.putKey(self, keyobj, key=u'', id_=u'', region=u'')
Change a key on the server-side keystore.
 
        Alter an AWS key in the keystore, specified by name, to contain
        new information.
 
        @param keyobj The AWSKey object with the name and updated info
 
        *OR* you can run with just the information for creating the
        AWSKey object and the function will construct it for you
 
        @param keyobj The user-defined name (a string) for the key.
        @param key The new AWS secret key.
        @param id_ The new AWS id.
        @param region The new AWS region.
        @throws TentenTransactionException if a key with this name does
                not already exist in the keystore (among other reasons.)
query(...)
Session.query(self, table, xml=u'')
Creates a query object for this session, for a given table and XML.  You
        can also pass an existing query object (from this or another
        session) to clone it in this session. The query is *not* run.
readKeys(...)
Session.readKeys(self)
Get a list of keys in the server-side keystore
 
        @returns a list of AWSKey objects
releaseUID(self, *args, **kwargs)
Session.releaseUID(self)
DEBUG ONLY: release a claimed UID
relog(...)
Session.relog(self, password, logintype=-1)
Returns a NEW session object, logging in again with the same URL
        and username, and the given password and logintype (default
        POSSESS). Other configurable properties are _not_ carried over into
        the new session. May be called on a closed session. (*)
saveTableMaterialize(self, *args, **kwargs)
Session.saveTableMaterialize(self, tablepath, title=u'', sdesc=u'', ldesc=u'', link=u'', int maxdown=-1, int replace=False, int append=False, int appendable=True, int temporary=False, users=None, char *segmentation=NULL, int sortseg=False, segbyAdvise=None, sortsegAdvise=None, int timeSeries=False, links=None, char *sort=NULL, *, inherit_users=False)
Creates, replaces, or appends a table.  Runs the CSDK
        tenten_SaveTableMaterialize function. This saves the most recently-run
        Query. (*)
        @param tablepath Path in the 1010 object tree to save this table.
        @param title Title of the table (default "")
        @param sdesc Short description (default "")
        @param ldesc Long description (default "")
        @param link String to be prepended to titles of linked columns
                (default "")
        @param maxdown Maximum number of cells that can be downloaded at once.
                Default -1, for no limit
        @param replace Replace the table if it already exists (default False)
        @param append Append to the end of an existing table (default False)
        @param appendable Allow this table to be merged with other tables
                (default False)
        @param temporary Make this table temporary (default False)
        @param users List of usernames with access (default None)
        @param segmentation Comma-separated string, a list of columns to
                segment on (Default None)
        @param sortseg Use SortSeg (True) or SegBy (False, default)
        @param segbyAdvise List of comma-separated column-name sequences
                which can be assumed to be segmented with SegBy segmentation
                if segmentation is performed (Default None)
        @param sortsegAdvise List of comma-separated column-name sequences
                which can be assumed to be segmented with SortSeg segmentation
                if segmentation is performed (Default None)
        @param timeSeries Generate time-series metadata (default False)
        @param links A list of 1010 link ops (default None)
        @param sort Comma-separated string, a list of columns by which to
                sort the contents of each segment (default None)
        @param inherit_users (keyword-only): If True, ignore the list of users
                given (if any) and set the user permissions to 'inherit'.
searchTables(self, *args, **kwargs)
Session.searchTables(self, filter=None, maxresults=0)
Searches for tables with matching names and returns a list of
        DirEntry objects. (*)
setRetry(self, *args, **kwargs)
Session.setRetry(self, long retryMax, long retryTimeMin, long retryTimeRange, double retryBase)
Sets retry parameters.
setUserAgent(...)
Session.setUserAgent(self, agent, password)
Set the UserAgent string.  For internal use only.
setXFF(self, *args, **kwargs)
Session.setXFF(self, xff)
Sets X-Forwarded-For string
stop(self, *args, **kwargs)
Session.stop(self)
Send a stop transaction
updateObject(self, *args, **kwargs)
Session.updateObject(self, dirname)
Refreshes this session's view of a file or a directory
        (recursively). (*)
uploadXMLTable(self, *args, **kwargs)
Session.uploadXMLTable(self, char *xmlbuf)
Uploads raw XML as a table (*)
warmPool(...) from builtins.type
Session.warmPool(type cls, url, owner, password, group, queries=None, logfile=None)

Data descriptors defined here:
APIversion
The API version of this session (Configurable)
closed
epw
The encrypted password of this session.
group
ignoreSSLErrors
Determines if you get an exception on SSL errors or ignore them
Default: False
lastResponse
The last response from the session
lastquery
lenient
logintype
messagetext
Message text of the session.
owner
pswd
PSWD of a session
rc
The return-code (integer) of the last transaction performed
realurl
reuseConnection
Determines if the same connection is reused between transactions
Default: True
sessionid
SID of a session
sid
The session ID of this session.
systemVersion
The system version this session is logged into
timeout
Connection timeout parameters, as a tuple: (connectTimeout, timeout)
Settable.
transactions
The raw bitmask of available transactions
url
userAgent
The user agent for this session
username

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from TentenObject:
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors inherited from TentenObject:
session
session: py1010.Session

 
class SourceColumnInfo(Holder)
    SourceColumnInfo(name=None, title=None, type_=None, format=None, int width=0, exp=None, double scale=0.0, int alpha=Alpha.SKIP, int order=0, int skip=Skip.NOSKIP, int nowrite=Write.WRITE, ptr=None, *)
Class for holding metadata about a column in a source to be uploaded.
 
    Several of the fields are meant to hold values from special enumeration
    classes, which are internal classes of SourceColumnInfo.  So the
    "nowrite" parameter can be SourceColumnInfo.Write.WRITE or
    SourceColumnInfo.Write.NOWRITE.  See below, and individual docstrings.
 
    Properties:
        name            Column name
        title           Column title
        type_           Type of column: a string (or bytes): "text", "int",
                                "float", or "bigint"
        format          Column format descriptor (string)
        width           Width of column; 0 (default) for no input width.
        exp             Expression to be applied to this column before
                                upload
        scale           Decimal value by which to divide this column before
                                upload.  0.0 (default) for none
        alpha           Alphabetic case into which to force this column before
                                upload.  One of Alpha.UPPER, Alpha.LOWER,
                                or Alpha.SKIP (default)
        order           Positive integer for the position of this column
                                in a reordering; 0 (default) for no reordering.
        skip            Skip this column or not?  One of Skip.SKIP or
                                Skip.NOSKIP (default)
        nowrite         Write this column?  One of Write.WRITE (default) or
                                Write.NOWRITE
 
 
Method resolution order:
SourceColumnInfo
Holder
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
SourceColumnInfo.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
SourceColumnInfo.__setstate_cython__(self, __pyx_state)

Data descriptors defined here:
alpha
Alphabetic case into which to force this column prior to upload:
SourceColumnInfo.Alpha.UPPER, SourceColumnInfo.Alpha.LOWER,
or SourceColumnInfo.Alpha.SKIP.
exp
Column expression.
format
Column format.
name
Name of the column.
nowrite
Whether or not to write this column.  Set to
SourceColumnInfo.Write.WRITE or SourceColumnInfo.Write.NOWRITE
order
A positive integer indicating this column's position in a revised
column order, or 0 for no reordering.
scale
Column scale: decimal value by which to divide the values
in this column prior to upload, or 0 for none.
skip
Whether or not to skip this column on loading.  Set to
SourceColumnInfo.Skip.SKIP or SourceColumnInfo.Skip.NOSKIP
title
Column title.
type
Type of column.  A string (or bytes), one of:
"text", "int", "float", "bigint"
width
Column width.

Data and other attributes defined here:
Alpha = <enum 'Alpha'>
An enumeration.
Skip = <enum 'Skip'>
An enumeration.
Write = <enum 'Write'>
An enumeration.
__pyx_vtable__ = <capsule object NULL>

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class SourceFile(Holder)
    SourceFile(path, bucket=None, keyname=None, sheetID=None, range=None, ptr=None, *)
Class describing an individual file as a data source.
 
    A "source" for 1010data is a description of some file outside of the
    1010data object tree.  A source is described by a SourceInfo object,
    which specifies features like format and column-separators, etc,
    and a SourceInfo contains one or more SourceFile objects, which
    specify locations of actual files (currently, in FTP upload directories
    or in S3 buckets.)
 
    Since a "source" describes an external resource, the same objects are
    used as "destinations" to describe files and formats for writing
    output.
 
 
Method resolution order:
SourceFile
Holder
builtins.object

Methods defined here:
__init__(...)
Construct a SourceFile object.
 
The SourceFile contains location information for a file outside of
1010 (either in an FTP upload directory or in an S3 bucket).
 
@param path The filename of the file.
@param bucket The S3 bucket, for files in S3.  Leave as None for
       files in FTP.
@param keyname The name assigned to the AWS key to use to access the
       file.  See the addKey method of {@link #Session} objects.
       Leave as None for files in FTP.
@param sheetID To specify a worksheet in an XLSX workbook, pass
       the sheet's ID here (as returned by the getworksheets
       transaction).
@param range For specifying a cell-range in an XSLX worksheet.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
SourceFile.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
SourceFile.__setstate_cython__(self, __pyx_state)
init(...)
SourceFile.init(self, path, bucket, keyname, sheetID, range)
Set object attributes on construction.

Data descriptors defined here:
bucket
The S3 bucket containing the file (or None).
keyname
The user-assigned name of the AWS key to use to access the file,
or None
path
The filename of the file.
range
A range of cells in an XLSX worksheet which this object refers
to, if relevant.
 
(Implementation note:  this property will not contain the value
None.  If you set it to None, that really sets it to b'')
sheetID
The sheetID of the worksheet this object refers to, within an
XLSX workbook, if relevant.
 
(Implementation note:  this property will not contain the value
None.  If you set it to None, that really sets it to b'')

Data and other attributes defined here:
__pyx_vtable__ = <capsule object NULL>

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class SourceInfo(SyncInfo)
    SourceInfo(files=None, rectype=None, sep=None, eor=None, maskw=None, mchr=None, arch=None, format=None, long begbytes=0, long begrecs=0, long numrecs=0, int autoCorrect=0, int numCols=0, ptr=None, *)
Class describing an individual file as a data source.
 
    A "source" for 1010data is a description of some file outside of the
    1010data object tree.  A source is described by a SourceInfo object,
    which specifies features like format and column-separators, etc,
    and a SourceInfo contains one or more SourceFile objects, which
    specify locations of actual files (currently, in FTP upload directories
    or in S3 buckets.)
 
    Since a "source" describes an external resource, the same objects are
    used as "destinations" to describe files and formats for writing
    output.
 
    SourceInfo objects contain metadata about the format of an external
    file.  Several of the fields are meant to hold values from special
    enumeration classes, which are internal classes of SourceInfo.  So
    the rectype can be SourceInfo.RecType.SEPARATED or
    SourceInfo.RecType.FIXED.  See below, and individual docstrings.
 
    Properties:
        sourceType              Type of source (FTP, S3, etc.)
        sep                     Column separator
        eor                     Record separator
        maskw                   Max length of variable-width columns
        mchr                    "Masking" character
        arch                    Architecture: little-endian or big-endian
        format                  Type of file ("xlsx" or empty)
        begbytes                Number of bytes to skip at the start
        begrecs                 Number of records to skip at the start
        numrecs                 Number of records to upload (0 for all)
        autoCorrect             Enable simple autocorrection feature?
        truncate                Autocorrect truncate control
        pad                     Autocorrect pad control
        fix_mask                Autocorrect fix-mask control
        numCols                 Number of columns
        ignoreNull              Replace '
 
 
Method resolution order:
SourceInfo
SyncInfo
Holder
builtins.object

Methods defined here:
__init__(...)
Constructor for SourceInfo objects.
 
@param files A list of SourceFile objects (or strings, which are
        taken to be filenames in an FTP directory)
@param rectype Record type: RecType.SEPARATED or RecType.FIXED or None
@param sep Column separator
@param eor Record separator
@param maskw Max width of variable columns
@param mchr "Masking" character
@param arch Architecture: Arch.BENDIAN or Arch.LENDIAN or None
@param format Either "xlsx" or None (default) for text files
@param begbytes Bytes to skip at the beginning (default 0)
@param begrecs Records to skip at the beginning (default 0)
@param numrecs Number of records to load (default 0, for "all")
@param autoCorrect Enable autoCorrect? (default 0 (False))
@param numCols Number of columns
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
SourceInfo.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
SourceInfo.__setstate_cython__(self, __pyx_state)
getWorksheets(...)
SourceInfo.getWorksheets(self, Session s)
Run the getworksheets transaction on this SourceInfo object
        (which should describe a .xlsx source) using the supplied session.
init(...)
SourceInfo.init(self, files=None, rectype=None, sep=None, eor=None, maskw=None, mchr=None, arch=None, format=None, long begbytes=0, long begrecs=0, long numrecs=0, int autoCorrect=0, int numCols=0)
Initialize fields on construction.

Data descriptors defined here:
arch
Architecture or "endianness" of this source.
May be Arch.BENDIAN (big-endian) or
ARCH.LENDIAN (little-endian) or None (unspecified).
autoCorrect
Specify "simple" autocorrection: True or False.
begbytes
Bytes to skip at the beginning.
begrecs
Records to skip at the beginning.
eor
Row separator for this Source.
files
files: object
filter_target
filter_target: object
fix_mask
Autocorrect fix-mask control, for delimited columns only.
Set to AutoCorrectType.NONE, AutoCorrectType.LEFT,
AutoCorrectType.RIGHT, AutoCorrectType.LONG, or
AutoCorrectType.SHORT.
format
File-format of this Source.  May be None or "" (for text files)
or "xslx".
ignoreNull
Replace NUL ('
maskw
The "masking width," or the maximum width of variable-length
columns in this source.  Default 10000.
mchr
Masking character for this Source.
numCols
Number of columns in input data.
numFiles
Number of SourceFiles in this Source.
This property may not be set directly.
numrecs
Number of records to read.
pad
Autocorrect pad control: Set to AutoCorrectType.NONE,
AutoCorrectType.RIGHT, or AutoCorrectType.LEFT.
rectype
Record type for this Source.
May be RecType.SEPARATED or RecType.FIXED or None (unspecified).
sep
Column separator for this Source.
sourceType
Type of this source.  May be SrcType.S3 or SrcType.FTP.
This property is not set directly, but is determined by whether
or not the first SourceFile has a "bucket" property set.
(SourceFiles on FTP and S3 may not be combined in the same
SourceInfo.)
stripefactor
Number of servers to replicate data on.  Unspecified (value None)
by default.
truncate
Autocorrect truncate control: Set to AutoCorrectType.NONE,
AutoCorrectType.RIGHT, or AutoCorrectType.LEFT.

Data and other attributes defined here:
Arch = <enum 'Arch'>
An enumeration.
AutoCorrectType = <enum 'AutoCorrectType'>
An enumeration.
RecType = <enum 'RecType'>
An enumeration.
SrcType = <enum 'SrcType'>
An enumeration.
__pyx_vtable__ = <capsule object NULL>

Methods inherited from SyncInfo:
__enter__(...)
SyncInfo.__enter__(self)
__exit__(...)
SyncInfo.__exit__(self, *args)

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class SourceSpec(Holder)
    A class to hold both SourceInfo and a list of SourceColumnInfo.
 
 
Method resolution order:
SourceSpec
Holder
builtins.object

Methods defined here:
__init__(self, source=None, sourceCols=None)
SourceSpec.__init__(self, source=None, sourceCols=None)
__repr__(self)
SourceSpec.__repr__(self)
toXML(self, session)
SourceSpec.toXML(self, session)
Convert to XML representation.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Holder.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Holder.__setstate_cython__(self, __pyx_state)

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class StructWrapper(builtins.object)
    StructWrapper(magic, clazz, ptr=None, *)
INTERNAL USE ONLY!
 
    Wrapper for C-level structures.  Works similarly to the Java2 SDK; see
    the comments there for description.
 
  Methods defined here:
__init__(...)
NEVER USE THIS!  Create objects with the _New class method.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
StructWrapper.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
StructWrapper.__setstate_cython__(self, __pyx_state)
wrapPtr(...) from builtins.type
StructWrapper.wrapPtr(type cls, ptr, clazz)
Internal use only!
 
        Never use this.  Only use the _New class method.

Data descriptors defined here:
PTR
NOT for use by users!
ptr

 
class SyncInfo(Holder)
    SyncInfo(*args, **kwargs)
 
 
Method resolution order:
SyncInfo
Holder
builtins.object

Methods defined here:
__enter__(...)
SyncInfo.__enter__(self)
__exit__(...)
SyncInfo.__exit__(self, *args)
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
SyncInfo.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
SyncInfo.__setstate_cython__(self, __pyx_state)

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class TableInfo(SyncInfo)
    TableInfo(name, int ID=0, title=None, sdesc=None, ldesc=None, type_=u'', int secure=0, int own=0, owner=None, update=None, int favorite=0, users=None, display=None, int report=0, int chart=0, link=u'', long numRows=0, long numBytes=0, int segs=0, int access=0, long maxdown=0, mode=Mode.REPLACE, ptr=None, *)
Class for holding metadata about a table as an upload target.
 
    Holds data about a table for uploading (with addTableSpecs).
 
    Several of the fields are meant to hold values from special
    enumeration classes, which are internal classes of TableInfo.  So
    the mode can be TableInfo.Mode.APPEND or TableInfo.Mode.REPLACE
    or TableInfo.Mode.NOREPLACE.  See below, and individual docstrings.
 
 
Method resolution order:
TableInfo
SyncInfo
Holder
builtins.object

Methods defined here:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
TableInfo.__reduce_cython__(self)
__repr__(self, /)
Return repr(self).
__setstate__ = __setstate_cython__(...)
TableInfo.__setstate_cython__(self, __pyx_state)
init(...)
TableInfo.init(self, name, int ID=0, title=None, sdesc=None, ldesc=None, type_=u'', int secure=0, int own=0, owner=None, update=None, int favorite=0, users=None, display=None, int report=0, int chart=0, link=u'', long numRows=0, long numBytes=0, int segs=0, int access=0, long maxdown=0, mode=Mode.REPLACE)

Data descriptors defined here:
access
Boolean 1 or 0 indicating whether or not this table
is accessible.
chart
Boolean 1 or 0 indicating whether or not chart
specifications are saved for this table.
display
favorite
Boolean 1 or 0 indicating whether or not the transaction
UID has favorited this table.
id
Unique identifier for this table.
ldesc
Long description of the table, if any.
link
Link header of table, or NULL for no link header.
materialize
Boolean 1 or 0 indicating whether or not this table is
materialized.
maxdown
Maximum download limit of table, or a non-positive integer
for the default maxdown.
merge
Boolean 1 or 0 indicating whether or not this table
is appendable.
method
Materialize method, or None for the default method.
mode
Append or replace?
name
Full path to the table.
numBytes
Number of bytes in the table.
numCols
Number of columns in this table.
numRows
Number of rows in the table.
own
Boolean 1 or 0 indicating whether or not the transaction
UID is the owner of this table.
owner
UID or groupname of the owner of this table, or None
for the default owner.
report
Boolean 1 or 0 indicating whether or not report
specifications are saved for this table.
responsible
Boolean 1 or 0 indicating whether or not the user is
responsible for replication of data.
sdesc
Short description of the table, if any.
secure
Boolean 1 or 0 indicating whether or not this table is
secure.  Deprecated in API.
segmentation
Comma-separated list of the names of segmentation columns.
segs
Number of segments spanned by this table.
segsize
Size of the segments of this table.
segtype
Integer representing segmentation type of this table.
Either TableInfo.SegType.SEGBY or TableInfo.SegType.SORTSEG.
0 if "segmentation" is None.
sort
Comma-separated list of the names of sort columns.
timeSeries
Integer representing whether or not time-series
segmentation is used for this table. Either TENTEN_TS
or TENTEN_NOTS. 0 if "segmentation" is None.
title
Title of the table, if any.
type
Type of table. Currently, can be "REAL", "VIEW", "PARAM",
"MERGED", "UQ", or "TOLERANT".
update
Datetime of last modification to this table.
users
users: object

Data and other attributes defined here:
Mode = <enum 'Mode'>
An enumeration.
Perm = <enum 'Perm'>
An enumeration.
SegType = <enum 'SegType'>
An enumeration.
TimeSeries = <enum 'TimeSeries'>
An enumeration.
__pyx_vtable__ = <capsule object NULL>

Methods inherited from SyncInfo:
__enter__(...)
SyncInfo.__enter__(self)
__exit__(...)
SyncInfo.__exit__(self, *args)

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class TableSpec(Holder)
    Class to hold a TableInfo and a list of ColumnInfo.
 
 
Method resolution order:
TableSpec
Holder
builtins.object

Methods defined here:
__init__(self, table=None, cols=None)
TableSpec.__init__(self, table=None, cols=None)
__repr__(self)
TableSpec.__repr__(self)
toXML(self, session)
TableSpec.toXML(self, Session session)
Convert to XML notation.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Methods inherited from Holder:
__eq__(self, value, /)
Return self==value.
__ge__(self, value, /)
Return self>=value.
__gt__(self, value, /)
Return self>value.
__le__(self, value, /)
Return self<=value.
__lt__(self, value, /)
Return self<value.
__ne__(self, value, /)
Return self!=value.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
Holder.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
Holder.__setstate_cython__(self, __pyx_state)

Data descriptors inherited from Holder:
PTR
A PyCapsule holding the struct's pointer.  Internal use only.
wrapper

Data and other attributes inherited from Holder:
__hash__ = None

 
class TentenClosedSessionException(TentenException)
    Exception for trying to access a session that has been closed.
 
 
Method resolution order:
TentenClosedSessionException
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TentenException(builtins.Exception)
    Common base class for all non-exit exceptions.
 
 
Method resolution order:
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TentenNotLastException(TentenException)
    Exception when something is done that would affect the "last" query,
but the calling query is not that query.
 
 
Method resolution order:
TentenNotLastException
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TentenNotRunException(TentenException)
    Exception for trying to access information about a query that has
not been run yet.
 
 
Method resolution order:
TentenNotRunException
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TentenObject(builtins.object)
    The wrapper object type for 1010data Insights Platform objects
 
  Methods defined here:
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.
__reduce__ = __reduce_cython__(...)
TentenObject.__reduce_cython__(self)
__setstate__ = __setstate_cython__(...)
TentenObject.__setstate_cython__(self, __pyx_state)
tentenentering(...)
TentenObject.tentenentering(self, fun, *args, **kwargs)
(log entering)

Data descriptors defined here:
session
session: py1010.Session

 
class TentenPoolFullException(TentenException)
    Exception for failing to log in using a login pool, after the
user-specified number of retries has been exhausted.
 
 
Method resolution order:
TentenPoolFullException
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
class TentenTransactionException(TentenException)
    Exception raised when something fails in creating or
running a transaction.
 
 
Method resolution order:
TentenTransactionException
TentenException
builtins.Exception
builtins.BaseException
builtins.object

Data descriptors inherited from TentenException:
__weakref__
list of weak references to the object (if defined)

Methods inherited from builtins.Exception:
__init__(self, /, *args, **kwargs)
Initialize self.  See help(type(self)) for accurate signature.
__new__(*args, **kwargs) from builtins.type
Create and return a new object.  See help(type) for accurate signature.

Methods inherited from builtins.BaseException:
__delattr__(self, name, /)
Implement delattr(self, name).
__getattribute__(self, name, /)
Return getattr(self, name).
__reduce__(...)
helper for pickle
__repr__(self, /)
Return repr(self).
__setattr__(self, name, value, /)
Implement setattr(self, name, value).
__setstate__(...)
__str__(self, /)
Return str(self).
with_traceback(...)
Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.

Data descriptors inherited from builtins.BaseException:
__cause__
exception cause
__context__
exception context
__dict__
__suppress_context__
__traceback__
args

 
Functions
       
DBG = DBG_dummy(...)
DBG_dummy(st)
DBG_dummy(...)
DBG_dummy(st)
DBG_real(...)
DBG_real(st)
(internal function: debug output)
INFO = INFO_dummy(...)
INFO_dummy(st)
INFO_dummy(...)
INFO_dummy(st)
INFO_real(...)
INFO_real(st)
(internal function: debug output)
admin(...)
admin(f)
('admin' decorator)
by(...)
by(s)
(internal function: string2bytes for python3)
entering(...)
entering(hsh, cls, fun, *args, **kwargs)
(internal function: log entering function)
except_msg(...)
except_msg(msg)
(decorator for exceptions)
except_zero(...)
except_zero(func)
(decorator to trap failure (zero) and raise exception)
except_zero2(...)
except_zero2(func)
(decorator to trap failure (zero) and raise exception)
exiting(...)
exiting(hsh, cls, fun)
(internal function: log exiting function)
flushpool(...)
flushpool(url, owner, password, group, logfile=None, mode=u'w')
Invokes the "markgid" or "FlushPool" transaction on the group.
    This guarantees that any subsequent UIDs returned for the group
    haven't been logged in before on a session and are fresh.(*)
initialize(...)
initialize(force=False)
Initialize 1010 API. You should not need to call this; creating a
    Session does this for you.
isfile(...)
isfile(f)
isnan(...)
isnan(x) -> bool
 
Return True if x is a NaN (not a number), and False otherwise.
logit(...)
logit(func)
(decorator for logging)
proxyparse(...)
proxyparse(s)
resetpool(*args, **kwargs)
resetpool(url, owner, password, group, logfile=None)
Invokes the "resetpool" transaction on the group.
    This releases *all* the group's UIDs.(*)
sleep(...)
sleep(seconds)
 
Delay execution for a given number of seconds.  The argument may be
a floating point number for subsecond precision.
st(...)
st(s)
(internal function: bytes2string for python3)
startLogging(...)
startLogging(filename=u'Py1010.log')
Starts API-level logging.
stopLogging(...)
stopLogging()
Close logging.
teardown(...)
teardown(force=False)
End and clean up 1010 API.
warmpool(...)
warmpool(url, owner, password, group, queries=None, logfile=None)
Warm a SAM Pool.  Returns the number of IDs warmed.

 
Data
        ADMIN = True
EPOCH = datetime.datetime(2035, 1, 1, 0, 0)
INTEGER64_INF = 9223372036854775807
INTEGER64_NA = -9223372036854775808
INTEGER64_NINF = -9223372036854775807
INTEGER_INF = 2147483647
INTEGER_NA = -2147483648
INTEGER_NINF = -2147483647
KILL = 1
LOGGING = False
NOKILL = 0
POSSESS = -1
PY3 = True
__test__ = {'Query.dictslice (line 887)': 'Return an ordered dictionary of lists, the dicti... to fit in memory when calling this. (*)\n '}
mutex = <threading.BoundedSemaphore object>
version_date = '20200903_1207'
version_git = 'cc2b26c10625e9e9fb6094f2dda8e3a6e332734f'
version_info = (2020, 9, 3, 1207)
version_numbers = (1, 1, 5)