快速开始

安装

可以通过以下三种方式安装 Borax ：

1) 使用 pip ：

  1. $ pip install borax

2) 使用 poetry 工具：

  1. $ poetry add borax

3) 使用开发代码

  1. git clone https://github.com/kinegratii/borax.git
  2. cd borax
  3. python setup.py install

导入

一般来说， 作为功能的代码基本组织形式，建议导入 包(Package) 和 模块(Module) 。

例如，导入 choices：

  1. from borax import choices
  3. class OffsetChoices(choices.ConstChoices):
  4.     up = choices.Item((0, -1), 'Up')
  5.     down = choices.Item((0, 1), 'Down')
  6.     left = choices.Item((-1, 0), 'Left')
  7.     right = choices.Item((0, 1), 'Right')

不建议使用以下导入方式

  1. from borax.choices import ConstChoices, Item

在某些情况下，也可以直接导入模块的 类(Class) 或 变量(Variate)。

  1. from borax.patterns.lazy import LazyObject
  3. class Point(object):
  4.     def __init__(self, x, y):
  5.         self.x = x
  6.         self.y = y
  8. p = LazyObject(Point,args=[1,2])
  9. print(p.x)

函数

borax 库在函数定义和调用方面，尽可能按照 PEP3102 声明函数参数，即某些参数必须以关键字形式传入参数。

  1. borax.choices.Items(value, display=None, *, order=None)

类型标注

从 v1.2.0 开始，部分模块支持 Typing Hint 。