pypbc的使用文档说明——官方版

百度好久也没有找到相关文档，

终于最终通过help（）寻得此文档，共勉

NAME
pypbc - pypbc

CLASSES
builtins.object
Element
Pairing
Parameters

class Element(builtins.object)
 |  Represents an element of a bilinear group.
 |  
 |  Basic usage:
 |  
 |  Element(pairing, G1||G2||GT||Zr, value=v) -> Element
 |  Element.one(pairing, G1||G2||GT||Zr) -> identity element for the given group.
 |  Element.zero(pairing, G1||G2||GT||Zr) -> identity element for the given group.
 |  Element.random(pairing, G1||G2||GT||Zr) -> random element of the given group.
 |  Element.from_hash(pairing, G1||G2||GT||Zr -> element whose value is determined by the given hash value.
 |  
 |  Most of the basic arithmetic operations apply. Please note that many of them
 |  do not make sense between groups, and that not all of these are checked for.
 |  
 |  Methods defined here:
 |  
 |  __add__(self, value, /)
 |      Return self+value.
 |  
 |  __eq__(self, value, /)
 |      Return self==value.
 |  
 |  __ge__(self, value, /)
 |      Return self>=value.
 |  
 |  __getitem__(self, key, /)
 |      Return self[key].
 |  
 |  __gt__(self, value, /)
 |      Return self>value.
 |  
 |  __ifloordiv__(self, value, /)
 |      Return self//=value.
 |  
 |  __init__(self, /, *args, **kwargs)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  __int__(self, /)
 |      int(self)
 |  
 |  __invert__(self, /)
 |      ~self
 |  
 |  __le__(self, value, /)
 |      Return self<=value.
 |  
 |  __len__(self, /)
 |      Return len(self).
 |  
 |  __lt__(self, value, /)
 |      Return self<value.
 |  
 |  __mul__(self, value, /)
 |      Return self*value.
 |  
 |  __ne__(self, value, /)
 |      Return self!=value.
 |  
 |  __neg__(self, /)
 |      -self
 |  
 |  __pow__(self, value, mod=None, /)
 |      Return pow(self, value, mod).
 |  
 |  __radd__(self, value, /)
 |      Return value+self.
 |  
 |  __repr__(self, /)
 |      Return repr(self).
 |  
 |  __rmul__(self, value, /)
 |      Return value*self.
 |  
 |  __rpow__(self, value, mod=None, /)
 |      Return pow(value, self, mod).
 |  
 |  __rsub__(self, value, /)
 |      Return value-self.
 |  
 |  __str__(self, /)
 |      Return str(self).
 |  
 |  __sub__(self, value, /)
 |      Return self-value.
 |  
 |  ----------------------------------------------------------------------
 |  Class methods defined here:
 |  
 |  from_hash(...) from builtins.type
 |      Creates an Element from the given hash value.
 |  
 |  one(...) from builtins.type
 |      Creates an element representing the multiplicative identity for its group.
 |  
 |  random(...) from builtins.type
 |      Creates a random element from the given group.
 |  
 |  zero(...) from builtins.type
 |      Creates an element representing the additive identity for its group.
 |  
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |  
 |  __new__(*args, **kwargs) from builtins.type
 |      Create and return a new object.  See help(type) for accurate signature.
 |  
 |  ----------------------------------------------------------------------
 |  Data and other attributes defined here:
 |  
 |  __hash__ = None

class Pairing(builtins.object)
 |  Pairing(parameters) -> Pairing object
 |  
 |  Represents a bilinear pairing, frequently referred to as e-hat.
 |  
 |  Methods defined here:
 |  
 |  __init__(self, /, *args, **kwargs)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  apply(...)
 |      applies the pairing.
 |  
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |  
 |  __new__(*args, **kwargs) from builtins.type
 |      Create and return a new object.  See help(type) for accurate signature.

class Parameters(builtins.object)
 |  A representation of the parameters of an elliptic curve.
 |  
 |  There are three basic ways to instantiate a Parameters object:
 |  Parameters(param_string=s) -> a set of parameters built according to s.
 |  Parameters(n=x, short=True/False) -> a type A1 or F curve.
 |  Parameters(qbits=q, rbits=r, short=True/False) -> type A or E curve.
 |  
 |  These objects are essentially only used for creating Pairings.
 |  
 |  Methods defined here:
 |  
 |  __init__(self, /, *args, **kwargs)
 |      Initialize self.  See help(type(self)) for accurate signature.
 |  
 |  __repr__(self, /)
 |      Return repr(self).
 |  
 |  __str__(self, /)
 |      Return str(self).
 |  
 |  ----------------------------------------------------------------------
 |  Static methods defined here:
 |  
 |  __new__(*args, **kwargs) from builtins.type
 |      Create and return a new object.  See help(type) for accurate signature.

FUNCTIONS
get_random(…)
get a random value less than n

get_random_prime(...)
    get a random n-bit prime

set_point_format_compressed(...)
    Set option to use compressed (sign + X) point format

set_point_format_uncompressed(...)
    Set option to use uncompressed (X,Y) point format

DATA
G1 = 0
G2 = 1
GT = 2
PBC_EC_Compressed = 1
Zr = 3