summaryrefslogtreecommitdiff
path: root/docs/api/base.rst
blob: 3e859fa7d125dc31f2c46646c5fe7aebfef123db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

Base API
========

.. currentmodule:: pint


These are the classes, exceptions and functions that you will most likely use.


Most important classes
----------------------

.. autoclass:: UnitRegistry
    :members:
    :exclude-members: Quantity, Unit, Measurement, Group, Context, System

.. autoclass:: Quantity
    :members:
    :inherited-members:

.. autoclass:: Unit
    :members:
    :inherited-members:

.. autoclass:: Measurement
    :members:
    :inherited-members:

Exceptions and warnings
-----------------------

.. autoexception:: PintError
    :members:

.. autoexception:: DefinitionSyntaxError
    :members:

.. autoexception:: LogarithmicUnitCalculusError
    :members:

.. autoexception:: DimensionalityError
    :members:

.. autoexception:: OffsetUnitCalculusError
    :members:

.. autoexception:: RedefinitionError
    :members:

.. autoexception:: UndefinedUnitError
    :members:

.. autoexception:: UnitStrippedWarning
    :members:


Sharing registry among packages
-------------------------------

.. autofunction:: get_application_registry
.. autofunction:: set_application_registry

Other functions
---------------

.. autofunction:: formatter
.. autofunction:: register_unit_format
.. autofunction:: pi_theorem
.. autoclass:: Context