原文:http://bcolz.blosc.org/en/latest/reference.html
First level variables
bcolz.__version__
'''
bcolz包的版本。
'''bcolz.dask_here
'''
是否检测到dask的最低版本。
'''bcolz.min_dask_version
'''
需要dask的最低版本(dask是可选的)。
'''bcolz.min_numexpr_version
'''
numexpr所需的最小版本(numexpr是可选的)。
'''bcolz.ncores
'''
检测到的核心数量。
'''bcolz.numexpr_here
'''
是否检测到最小版本的数字。
'''Top level classes
class bcolz.cparams(clevel = None,shuffle = None,cname = None,quantize = None ):
'''
用于承载压缩和其他过滤器参数的类。
参数:
clevel:int(0 <= clevel <10)
压缩级别。
shuffle:int
洗牌过滤器被激活。允许的值是bcolz.NOSHUFFLE(0),bcolz.SHUFFLE(1)和bcolz.BITSHUFFLE(2)。默认是bcolz.SHUFFLE。
cname:string('blosclz','lz4','lz4hc','snappy','zlib','zstd')
选择Blosc内使用的压缩器。
quantize :int(有效位数)
量化数据以改善(有损)压缩。使用np.around(scale * data)/ scale来量化数据,其中比例是2**bits,bits由quantize值确定。例如,如果quantize=1,则位将是4.0意味着量化被禁用。
如果一些参数没有通过,他们会设置为默认值(请参阅`setdefaults()`方法)。
'''属性
| clevel | 压缩级别。 |
| cname | 压缩机名称。 |
| quantize | 量化过滤器。 |
| shuffle | 随机滤波器。 |
方法
setdefaults([clevel,shuffle,cname,quantize]) 更改压缩参数的默认值。
static setdefaults(clevel = None,shuffle = None,cname = None,quantize = None )
'''
参数:
clevel:int(0 <= clevel <10)
压缩级别。
shuffle:int
洗牌过滤器被激活。允许的值是bcolz.NOSHUFFLE(0),bcolz.SHUFFLE(1)和bcolz.BITSHUFFLE(2)。默认是bcolz.SHUFFLE。
cname:string('blosclz','lz4','lz4hc','snappy','zlib','zstd')
选择Blosc内使用的压缩器。
quantize :int(有效位数)
量化数据以改善(有损)压缩。使用np.around(scale * data)/ scale来量化数据,其中比例是2**bits,bits由量化值确定。例如,如果quantize=1,则位将是4.0意味着量化被禁用。
如果这个方法没有被调用,默认值将被设置为
defaults.py:
(``{clevel = 5,shuffle = bcolz.SHUFFLE,cname ='lz4',quantize = None}``)。
'''carray / ctable对象中的属性的访问器。
class bcolz.attrs.attrs(rootdir,mode,_new = False )这个类的行为与字典非常类似,属性可以通过以下方式添加:
attrs [ 'myattr' ] = 值并可以同样检索:
value = attrs [ 'myattr' ]属性可以被删除:
del attrs [ 'myattr' ]这个类也授予__iter__和__len__特殊功能。而且,getall()方法将所有属性作为字典返回。
CAVEAT:这些值应该能够用JSON序列化以进行持久化。
方法
getall() 另外,请参阅下面的carray和ctable类。
Top level functions
bcolz.arange([ start,] stop,[ step,] dtype = None,** kwargs)
'''
在给定的时间间隔内返回均匀间隔的值。
值在半开区间内 (换句话说,包括开始但不包括停止的区间)生成。对于整数参数,这个函数等价于Python内建的 范围函数,但返回的是一个carray而不是一个列表。[start, stop)
参数:
start : number,可选
间隔开始。间隔包括这个值。默认的起始值是0。
stop : number
间隔结束。间隔不包括这个值。
step: number,可选
值之间的间隔。对于任何输出出来,这是两个相邻值之间的距离,。默认步长为1.如果指定了step,则还必须给出start。out[i+1] - out[i]
dtype:dtype
输出数组的类型。如果没有给出dtype,则从其他输入参数推断数据类型。
kwargs:list of parameters or dictionary
carray构造函数支持的任何参数。
返回:
out:carray
Bcolz对象由均匀间隔的值组成。
对于浮点参数,结果的长度是 。由于浮点溢出,此规则可能导致out的最后一个元素大于stop。ceil((stop - start)/step)
'''bcolz.eval(expression,vm = None,out_flavor = None,user_dict = None,blen = None,** kwargs )
'''
评估一个表达式并返回结果。
参数:
expression :string
形成表达式的字符串,如"2 * a + 3 * b"。"a"和"b"的值是从调用函数的框架中获取的变量名称。这些变量可能是标量,carrays或NumPy数组。
vm:string
计算中使用的虚拟机。它可以是'numexpr','python'或'dask'。如果已安装,则默认使用"numexpr"。
out_flavor:string
外面的对象的味道。它可以是"bcolz"或"numpy"。如果没有,那么这个值是从bcolz.defaults.out_flavor得到的。
user_dict:dict
用户提供的字典,可以通过名称找到表达式中的变量。
blen:int
要在一个内部进行评估的块的长度。默认值是经过实验测试的值,提供足够好的性能/内存使用平衡。
kwargs:list of parameters or dictionary
carray构造函数支持的任何参数。
返回:
out:bcolz或numpy对象
expression的结果。如果out_flavor ='bcolz',则可以通过传递kwargs中 carray构造函数支持的其他参数来调整此对象的属性 。
'''bcolz.fill(shape,dtype = float,dflt = None,** kwargs )
'''
返回给定shape 和 type的新的carray或ctable对象,填充 dflt。
参数:
shape:int
新阵列的形状,例如(2,3)。
dflt:Python or NumPy scalar
在灌装过程中使用的值。如果没有,值填充零。此外,所得的CARRAY将这个值作为其DFLT值。
dtype:data-type,可选
数组所需的数据类型,例如numpy.int8。默认是 numpy.float64。
kwargs: list of parameters or dictionary
carray构造函数支持的任何参数。
返回:
out:carray or ctable
Bcolz对象用给定的形状和dtype填充了dflt值。
'''bcolz.fromiter(iterable,dtype,count,** kwargs )
'''
从可迭代对象创建一个carray / ctable 。
参数:
iterable : iterable object
一个可迭代的对象,为数据提供数据。
dtype :numpy.dtype实例
指定结果对象的类型。
count:int
要从迭代中读取的项目数量。如果设置为-1,则意味着迭代将被使用,直到耗尽(不推荐,请参阅下面的注释)。
kwargs:list of parameters or dictionary
Carray / ctable构造函数支持的任何参数。
返回:
out:一个carray / ctable对象
'''Notes:
请指定count以提高性能并节省内存。它允许fromiter避免循环迭代两次(这是slooow)。它也避免了内存泄漏的发生(对于大型迭代器来说这可能很重要)。
bcolz.iterblocks(cobj, blen=None, start=0, stop=None)
'''
在size长度内的块中迭代cobj(carray / ctable)。
参数:
cobj:carray / ctable对象
bcolz对象被迭代。
blen:int
返回的块的长度。缺省值是chunklen,或者ctable,是不同列数据块的最小值。
start :int
迭代器开始的地方。默认是从头开始。
stop:int
迭代器停止的地方。默认是在最后停止。
返回:
out:可迭代的
这个迭代器将数据块作为同类或结构类型的NumPy数组返回,这取决于cobj是carray还是ctable对象。
'''bcolz.ones(shape, dtype=float, **kwargs)
'''
返回给定的shape和type的新的carray对象，用1填充。
参数:
shape:int
新阵列的shape,例如(2,3)。
dtype:data-type,可选
数组所需的数据类型,例如numpy.int8。默认是 numpy.float64。
kwargs: list of parameters or dictionary
carray构造函数支持的任何参数。
返回:
out:carray or ctable
具有给定shape和dtype的Bcolz对象。
'''bcolz.zeros(shape, dtype=float, **kwargs)
'''
返回给定shape和type型的新的Carray对象,用0填充。
参数:
shape:int
新阵列的形状,例如(2,3)。
dtype:数据类型,可选
数组所需的数据类型,例如numpy.int8。默认是 numpy.float64。
kwargs:参数或字典的列表
carray构造函数支持的任何参数。
返回:
out:carray or ctable
具有给定shape和dtype的0的Bcolz对象。
'''bcolz.open(rootdir, mode='a')
'''
打开一个基于磁盘的carray / ctable。
参数:
rootdir:路径名(字符串)
承载carray / ctable对象的目录。
mode:打开模式(字符串)
指定打开对象的模式。支持的值是:
'r'为只读
'w'清空以前的基础数据
'a'允许在现有数据之上进行读写
返回:
out:一个carray / ctable对象或IOError(如果没有找到对象)
'''bcolz.walk(dir, classname=None, mode='a')
'''
递归迭代carir / ctable挂在dir上的对象。
参数:
dir:string
列表从哪个目录开始。
classname:string
如果指定,则只返回此类的对象。支持的值是"carray"和"ctable"。
mode:string
模式应该打开。
返回:
out:iterator
遍历找到的对象。
'''Top level printing functions
bcolz.array2string(a, max_line_width=None, precision=None, suppress_small=None, separator=' ', prefix="", style=repr, formatter=None)
'''
返回carray / ctable对象的字符串表示形式。
这与NumPy中的功能相同。有关更多信息，请参阅NumPy文档。
'''bcolz.get_printoptions()
'''
返回当前的打印选项。
这与NumPy中的功能相同。有关更多信息，请参阅NumPy文档。
'''bcolz.set_printoptions(precision=None, threshold=None, edgeitems=None, linewidth=None, suppress=None, nanstr=None, infstr=None, formatter=None)
'''
设置打印选项。
这些选项决定了显示Carray对象中浮点数的方式。这与NumPy中的功能相同。有关更多信息，请参阅NumPy文档。
'''Utility functions
bcolz.set_nthreads(nthreads)
'''
设置bcolz操作期间使用的线程数。
这对Blosc和Numexpr都有影响（如果有的话）。如果只想为Blosc更改此数字，请改为使用blosc_set_nthreads。
参数：
nthreads：int
bcolz操作期间要使用的线程数。
返回：
out：int
之前设置的线程数。
'''bcolz.blosc_set_nthreads(nthreads)
'''
设置Blosc可以使用的线程数。
参数：
nthreads：int
所需的线程数量。
返回：
out：int
之前设置的线程数。
'''bcolz.detect_number_of_cores()
'''
返回此系统中的核心数量。
'''bcolz.blosc_version()
'''
返回Blosc库的版本。
'''bcolz.print_versions()
'''
打印bcolz依赖的软件包的所有版本。
'''bcolz.test(verbose=False, heavy=False)
'''
运行测试套件中的所有测试。
如果设置了详细信息，测试套件将发出完全冗长的消息（除非您正在查找某个问题，否则不建议）。
如果重设置，测试套件将在运行重模式（你要小心这一点，因为它可以从您的计算机大量的时间和资源）。
'''The carray class
class bcolz.carray():
'''
内存中或磁盘上的压缩和可扩展数据容器。
Carray公开了一系列以类似NumPy的方式处理压缩容器的方法。
参数：
array ：类似于NumPy的对象
这被作为输入来创建carray。它可以是任何可以转换成NumPy对象的Python对象。生成的carray的数据类型将与此NumPy对象相同。
cparams：cparams类的实例，可选
内部Blosc压缩机的参数。
dtype：NumPy dtype
这种力的D型为CARRAY（而非阵列之一）。
dflt：Python或NumPy标量
扩大Carray时使用的值。如果没有，默认填充零。
expectedlen：int，可选
猜测这个对象的预期长度。这将有助于确定用于压缩和内存I / O目的的最佳块。
chunklen：int，可选
适合块的项目数量。通过指定它可以显式设置用于压缩和内存I / O的块大小。只有在你知道你在做什么的时候才使用它。
rootdir：str，可选
所有数据和元数据将被存储的目录。如果指定，那么carray对象将是基于磁盘的（即，所有块将存储在磁盘上，而不是存储器中）并且是永久的（即，可以在其他会话中恢复，例如通过open（）顶层函数）。
safe：bool （默认为True）
强制输入数组类型。如果您始终正确输入类型，跨步和异形数组，并且从不使用Object dtype，则设置为false。
模式：str，可选
应该创建/打开一个持久的 carray 的模式。值可以是：
'r'为只读
'w'用于读/写。在创建卡时，如果rootdir存在，它将被删除。在开放的过程中，Carray将被调整为0。
'append'（rootdir中的可能数据不会被删除）。
'''
属性:
| atomsize | atomsize：’int’ |
| attrs | 属性访问器。 |
| cbytes | 此对象的压缩大小（以字节为单位）。 |
| chunklen | 这个对象的块（行）。 |
| chunks | 块：对象 |
| cparams | 此对象的压缩参数。 |
| dflt | 此对象的默认值。 |
| dtype | 这个对象的dtype。 |
| itemsize | itemsize：’int’ |
| leftover_array | 包含剩余块的数组（未压缩块） |
| leftover_bytes | leftover_array中的字节数 |
| leftover_elements | leftover_array中的元素数目 |
| leftover_ptr | 指向leftover_array的指针 |
| len | 此对象的长度（主要维度）。 |
| mode | 用于创建/打开模式的模式。 |
| nbytes | 此对象的原始（未压缩）大小（以字节为单位）。 |
| nchunks | 卡车中的块数 |
| ndim | 这个对象的维数。 |
| nleftover | 剩余元素的数量。 |
| partitions | 指示每个块的边界的元组列表 |
| rootdir | 用于持久性的磁盘目录。 |
| safe | 是否对每个操作进行类型/形状检查。 |
| shape | 这个对象的形状。 |
| size | 这个对象的大小。 |
方法:
| append(self, array) | 追加一个numpy 数组到这个实例。 |
| copy(self, **kwargs) | 返回此对象的副本。 |
| flush(self) | 将内部缓冲区中的数据刷新到磁盘。 |
| free_cachemem(self) | 释放内存中的缓存块 |
| iter(self[, start, stop, step, limit, skip, …]) | 迭代器具有启动，停止和分步界限。 |
| next() | |
| purge(self) | 删除磁盘阵列的基础数据。 |
| reshape(self, newshape) | 返回包含具有新形状的相同数据的新Carray。 |
| resize(self, nitems) | 将实例的大小调整为具有nitems。 |
| sum(self[, dtype]) | 返回数组元素的总和。 |
| trim(self, nitems) | 从这个实例中删除尾随的名词。 |
| view(self) | 创建原始数据的重量轻的视图。 |
| where(self, boolarr[, limit, skip]) | Iterator返回booleanr为true 的这个对象的值。 |
| wheretrue(self[, limit, skip]) | 在这个对象为真的情况下返回索引的迭代器。 |
__getitem__
x .__ getitem __（key）<==> x [key]
'''
返回基于键的值。ndarray.__getitem__()支持所有的功能 （包括花哨索引），以及对表达式的特殊支持：
参数：
key : string
它将被解释为布尔表达式（通过eval计算 ），并且这些值为true的元素将作为NumPy数组返回。
'''__setitem__
x .__ setitem __（key，value）<==> x [key] = value
'''
根据键设置值。ndarray.__setitem__()支持所有的功能 （包括花哨索引），以及对表达式的特殊支持：
参数：
key : string
它将被解释为布尔表达式（通过eval计算 ），并且这些值为true的元素将被设置为值。
'''append(self, array)
'''
追加一个numpy 数组到这个实例。
参数：
array：类似于NumPy的对象
要附加的数组。必须与卡路里的shape 和 type兼容。
'''atomsize
'''
atomsize：'int'
'''attrs
'''
属性访问器。
'''cbytes
'''
此对象的压缩大小（以字节为单位）。
'''chunklen
'''
这个对象的块（行）。
'''chunks
'''
chunks: object
'''copy(self, **kwargs)
'''
返回此对象的副本。
参数：
kwargs：参数或字典的列表
carray构造函数支持的任何参数。
返回：
出来：carray对象
这个对象的副本。
'''cparams
'''
此对象的压缩参数。
'''dflt
'''
此对象的默认值。
'''dtype
'''
这个对象的dtype。
'''flush()
'''
将内部缓冲区中的数据刷新到磁盘。
这个调用通常应该在执行修改后(__settitem __()，append()在持久性模式下完成。如果您不这样做，您可能会失去部分修改。
'''free_cachemem()
'''
释放内存中的缓存块
'''itemsize
'''
itemsize：'int'
'''iter(self, start=0, stop=None, step=1, limit=None, skip=0, _next=False)
'''
迭代器具有启动，停止和分步界限。
参数:
start :int
起始项目。
stop:int
迭代器停止的项目。
步骤:int
在每次迭代中递增的项目数量。不能是负面的。
limit:int
要返回的元素的最大数量。默认是返回一切。
skip:int
要跳过的元素的初始数量。默认值是0。
返回:
out:迭代器
'''leftover_array
'''
包含剩余块的数组（未压缩块）
'''leftover_bytes
'''
leftover_array中的字节数
'''leftover_elements
'''
leftover_array中的元素数目
'''leftover_ptr
'''
指向leftover_array的指针
'''len
'''
此对象的长度（主要维度）。
'''mode
'''
用于创建/打开模式的模式。
'''nbytes
'''
此对象的原始（未压缩）大小（以字节为单位）。
'''nchunks
'''
卡车中的块数
'''ndim
'''
这个对象的维数。
'''nextnleftover
'''
剩余元素的数量。
'''partitions
'''
指示每个块的边界的元组列表
'''purge(self)
'''
删除磁盘阵列的基础数据。
'''reshape(self, newshape)
'''
返回包含具有新形状的相同数据的新Carray。
参数：
newshape：int或int的元组
新的形状应该与原来的形状兼容。如果是整数，那么结果将是该长度的一维数组。一个形状尺寸可以是-1。在这种情况下，该值是从数组的长度和剩余维度中推断出来的。
返回：
reshaped_array：CARRAY
原车的副本。
'''resize(self, nitems)
'''
将实例的大小调整为具有nitems。
参数：
nitems：int
对象的最终长度。如果nitems大于实际长度，则使用self.dflt作为填充值添加新项目。
'''rootdir
'''
用于持久性的磁盘目录。
'''safe
'''
是否对每个操作进行类型/形状检查。
'''shape
'''
这个对象的形状。
'''size
'''
这个对象的大小。
'''sum(self, dtype=None)
'''
返回数组元素的总和。
参数：
dtype：NumPy dtype
所需的输出类型。如果None，使用自己的dtype 。一个例外是当自己具有比默认的平台，精确到整数以下的整数类型。在这种情况下，使用默认的平台整数（NumPy约定）。
返回：
out：NumPy与dtype的标量
'''trim(self, nitems)
'''
从这个实例中删除尾随的名词。
参数：
nitems：int
尾随项目的数量将被修剪。如果为负，则该对象将被放大。
'''view(self)
'''
创建原始数据的重量轻的视图。
返回：
出来：carray对象
这个对象的视图。
'''where(self, boolarr, limit=None, skip=0)
'''
Iterator返回booleanr为true 的这个对象的值。
这目前仅适用于一维的布尔曲线。
参数：
boolarr：布尔类型的Carray或NumPy数组
布尔值。
limit：int
要返回的元素的最大数量。默认是返回一切。
skip：int
要跳过的元素的初始数量。默认值是0。
返回：
out：迭代器
'''wheretrue(self, limit=None, skip=0)
'''
在这个对象为真的情况下返回索引的迭代器。
这目前仅适用于一维的布尔曲线。
参数：
limit：int
要返回的元素的最大数量。默认是返回一切。
skip：int
要跳过的元素的初始数量。默认值是0。
返回：
out：迭代器
'''The ctable class
class bcolz.ctable.ctable(columns=None, names=None, **kwargs):
'''
这个类表示一个压缩的列式表。
使用可选名称从cols创建一个新的ctable 。
参数：
columns： tuple or list of column objects
建立ctable对象的列数据列表。这些通常是carrays，但也可以是NumPy数组列表或纯NumPy结构化数组。列表或元组列表也是有效的，只要它们可以被转换成卡雷对象。
names： list of strings or string
列的名称列表。在此列表中的名称必须是合法的Python标识，不得以下划线开始，并在相同的顺序指定的cols。如果没有通过，名字将被选择为'f0'为第一列，'f1'为第二，依此类推（NumPy约定）。
kwargs：list of parameters or dictionary
允许传递carray构造函数支持的其他参数，以防需要构建新的carrays。
'''Notes:
作为carrays传递的列不会被复制，因此即使您传递其他参数（cparams，chunklen …），它们的设置也将保持不变。
属性:
| cbytes | 此对象的压缩大小（以字节为单位）。 |
| cparams | 此对象的压缩参数。 |
| dtype | 这个对象的数据类型（numpy dtype）。 |
| names | 对象（列表）的列名。 |
| nbytes | 此对象的原始（未压缩）大小（以字节为单位）。 |
| ndim | 这个对象的维数。 |
| shape | 这个对象的形状。 |
| size | 这个对象的大小。 |
方法:
| addcol(newcol[, name, pos, move]) | 添加一个新的newcol对象作为列。 |
| append(cols) | 将cols添加到此ctable。 |
| copy(**kwargs) | 返回这个ctable的副本。 |
| delcol([name, pos, keep]) | 删除名为name的列或pos位置。 |
| eval(expression, **kwargs) | 评估列上的表达式并返回结果。 |
| fetchwhere(expression[, outcols, limit, …]) | 获取满足表达条件的行。 |
| flush() | 将内部缓冲区中的数据刷新到磁盘。 |
| free_cachemem() | 摆脱内部缓存来释放内存。 |
| fromdataframe(df, **kwargs) | 从pandas dataFrame中返回一个ctable对象。 |
| fromhdf5(filepath[, nodepath]) | 从复合HDF5数据集（PyTables表）中返回一个ctable对象。 |
| iter([start, stop, step, outcols, limit, …]) | 迭代器具有启动，停止和分步界限。 |
| resize(nitems) | 将实例的大小调整为具有nitems。 |
| todataframe([columns, orient]) | 从这个对象中返回一个pandas dataFrame。 |
| tohdf5(filepath[, nodepath, mode, cparams, …]) | 将此对象写入HDF5文件。 |
| trim(nitems) | 从这个实例中删除尾随的名词。 |
| where(expression[, outcols, limit, skip, …]) | 遍历表达式为true的行。 |
| whereblocks(expression[, blen, outcols, …]) | 迭代满足表达式条件的行，以大小为单位的块。 |
addcol(newcol, name=None, pos=None, move=False, **kwargs)
'''
添加一个新的newcol对象作为列。
参数：
newcol：carray, ndarray, list or tuple
如果通过，则不进行转换。如果必须转换成carray，kwargs将适用。
name：string,可选
新列的名称。如果没有通过，它会收到一个自动名称。
pos：int，可选
列位置。如果不通过，将在最后附加。
move：boolean，可选
如果新列是现有的基于磁盘的卡路里，应该a）复制数据目录（False）或b）移动数据目录（True）
kwargs：list of parameters or dictionary
carray构造函数支持的任何参数。
'''Notes:
除非它们兼容，否则不应该同时指定name和pos参数。
append(cols)
'''
将cols添加到此ctable。
参数：
cols：标量值的列表/元组，NumPy数组或carrays
它也可以是一个NumPy记录，一个NumPy recarray或另一个ctable。
'''cbytes
'''
此对象的压缩大小（以字节为单位）。
'''cols = None
'''
ctable列访问器。
'''copy(**kwargs)
'''
返回这个ctable的副本。
参数：
kwargs：list of parameters or dictionary
Carray / ctable构造函数支持的任何参数。
返回：
out：ctable对象
这个ctable的副本。
'''cparams
'''
此对象的压缩参数。
'''delcol(name=None, pos=None, keep=False)
'''
删除名为name的列或pos位置。
参数：
name: string, 可选
要删除的列的名称。
pos：int，可选
要删除的列的位置。
keep: boolean
对于支持磁盘的列：将数据保存在磁盘上？
'''Notes:
您必须至少指定一个name或pos。你不应该同时指定name和pos参数，除非它们是兼容的。
dtype
'''
这个对象的数据类型（numpy dtype）。
'''eval(expression, **kwargs)
'''
评估列上的表达式并返回结果。
参数：
expression : string
形成表达式的字符串，如“2 * a + 3 * b”。“a”和“b”的值是从调用函数的框架中获取的变量名称。这些变量可以是这个表中的列名，标量，carrays或NumPy数组。
kwargs：list of parameters or dictionary
eval()顶级函数支持的任何参数。
返回：
out：bcolz对象
表达的结果。你可以通过在kwargs中传递carray构造函数支持的附加参数来定制这个对象的属性。
'''fetchwhere(expression, outcols=None, limit=None, skip=0, out_flavor=None, user_dict={}, vm=None, **kwargs)
'''
获取满足表达条件的行。
参数：
expression : string or carray
一个布尔Numexpr表达式或一个布尔carray。
outcols：list of strings or string
您想要返回结果的列名称列表。或者，可以将其指定为诸如“f0 f1”或“f0，f1”的字符串。如果没有，则返回所有的列。如果存在特殊名称“ nrow__ ”，则输出中将包含行数。
limit：int
要返回的元素的最大数量。默认是返回一切。
skip：int
要跳过的元素的初始数量。默认值是0。
out_flavor：string
外面的对象的味道。它可以是“bcolz”或“numpy”。如果没有，那么这个值是从bcolz.defaults.out_flavor得到的。
user_dict：dict
用户提供的字典，可以通过名称找到表达式中的变量。
vm：string
计算中使用的虚拟机。它可以是'numexpr'，'python'或'dask'。如果已安装，则默认使用“numexpr”。
kwargs：list of parameters or dictionary
carray构造函数支持的任何参数。
返回：
out：bcolz或numpy对象
表达的结果。如果out_flavor ='bcolz'，则可以通过传递kwargs中 carray构造函数支持的其他参数来调整此对象的属性。
'''flush()
'''
将内部缓冲区中的数据刷新到磁盘。
这个调用通常应该在执行修改后（__settitem __（），append（））在持久性模式下完成。如果您不这样做，您可能会失去部分修改。
'''free_cachemem()
'''
摆脱内部缓存来释放内存。
这个调用通常可以在从carray / ctable读取后进行，以释放内部使用的内存来缓存数据块/数据块。
'''static fromdataframe(df, **kwargs)
'''
从pandas dataFrame中返回一个ctable对象。
参数：
df：DataFrame
一个pandas dataframe.。
kwargs：list of parameters or dictionary
ctable构造函数支持的任何参数。
返回：
out：ctable对象
一个填充了df值的ctable 。
'''Notes:
如果可能的话，’object’dtype将被转换成’S’字符串类型。这可以在bcolz中节省更多的存储空间。
static fromhdf5(filepath, nodepath='/ctable', **kwargs)
'''
从复合HDF5数据集（PyTables表）中返回一个ctable对象。
参数:
filepath : string
HDF5文件的路径。
nodepath : string
HDF5文件内节点的路径。
kwargs : list of parameters or dictionary
ctable构造函数支持的任何参数。
返回:
out : ctable object
填充了来自HDF5节点的值的ctable。
'''iter(start=0, stop=None, step=1, outcols=None, limit=None, skip=0, out_flavor=<function namedtuple>)
'''
迭代器具有启动，停止和分步界限。
Parameters:
start : int
起始项目。
stop : int
迭代器停止的项目。
step : int
在每次迭代中递增的项目数量。不能是负的。
outcols : list of strings or string
您想要返回结果的列名称列表。或者，可以将其指定为诸如“f0 f1”或“f0，f1”的字符串。如果没有，则返回所有的列。如果存在特殊名称“ nrow__ ”，则输出中将包含行数。
limit : int
要返回的元素的最大数量。默认是返回一切。
skip : int
要跳过的元素的初始数量。默认值是0。
out_flavor : namedtuple, tuple or ndarray
返回的行是否被命名为元组或元组。默认是命名元组。
Returns:
out : iterable
'''names
'''
对象（列表）的列名。
'''nbytes
'''
此对象的原始（未压缩）大小（以字节为单位）。
'''ndim
'''
这个对象的维数。
'''resize(nitems)
'''
将实例的大小调整为具有nitems。
参数：
nitems：int
实例的最终长度。如果nitems大于实际长度，则使用self.dflt作为填充值添加新项目。
'''shape
'''
这个对象的形状。
'''size
'''
这个对象的大小。
'''todataframe(columns=None, orient='columns')
'''
Return a pandas dataframe out of this object.
Parameters:
columns : sequence of column labels, 可选
如果orient ='index'，必须通过。
orient : {‘columns’, ‘index’}, default ‘columns’
数据的“方向”。如果输入的键与列标签相对应，则传递“列”（默认）。否则，如果键对应于索引，则传递“索引”。
Returns:
out : DataFrame
A pandas DataFrame filled with values from this object.
'''tohdf5(filepath, nodepath='/ctable', mode='w', cparams=None, cname=None)
'''
将此对象写入HDF5文件。
Parameters:
filepath : string
HDF5文件的路径。
nodepath : string
HDF5文件内节点的路径。
mode : string
打开PyTables文件的模式。默认是'w'rite模式。
cparams : cparams object
压缩参数。默认值与当前的bcolz环境相同。
cname : string
PyTables支持的任何压缩器（例如'zlib'）。缺省情况下，将“blosc”作为元压缩器与其中一台压缩机组合使用（请参阅上面的cparams参数）。'''trim(nitems)
'''
从这个实例中删除尾随的名词。
参数：
nitems：int
尾随项目的数量将被修剪。
'''where(expression, outcols=None, limit=None, skip=0, out_flavor=<function namedtuple>, user_dict={}, vm=None)
'''
遍历表达式为true的行。
参数：
expression : string or carray
一个布尔Numexpr表达式或一个布尔carray。
outcols : list of strings or string
您想要返回结果的列名称列表。或者，可以将其指定为诸如“f0 f1”或“f0，f1”的字符串。如果没有，则返回所有的列。如果存在特殊名称“ nrow__ ”，则输出中将包含行数。
limit：int
要返回的元素的最大数量。默认是返回一切。
skip：int
要跳过的元素的初始数量。默认值是0。
out_flavor：namedtuple，tuple或者ndarray
返回的行是否被命名为元组或元组。默认是命名元组。
user_dict：dict
用户提供的字典，可以通过名称找到表达式中的变量。
vm：string
计算中使用的虚拟机。它可以是'numexpr'，'python'或'dask'。如果已安装，则默认使用“numexpr”。
返回：
out : iterable
'''whereblocks(expression, blen=None, outcols=None, limit=None, skip=0, user_dict={}, vm=None)
'''
迭代满足表达式条件的行，以大小为单位的块。
参数：
expression : string or carray
一个布尔Numexpr表达式或一个布尔carray。
blen：int
返回的块的长度。缺省值是chunklen，或者ctable，是不同列数据块的最小值。
outcols：list of strings or string
您想要返回结果的列名称列表。或者，可以将其指定为诸如“f0 f1”或“f0，f1”的字符串。如果没有，则返回所有的列。如果存在特殊名称“ nrow__ ”，则输出中将包含行数。
limit：int
要返回的元素的最大数量。默认是返回一切。
skip：int
要跳过的元素的初始数量。默认值是0。
user_dict：dict
用户提供的字典，可以通过名称找到表达式中的变量。
vm：string
计算中使用的虚拟机。它可以是'numexpr'，'python'或'dask'。如果已安装，则默认使用“numexpr”。
返回：
out：iterable
迭代返回的是混合长度的numpy对象。
'''