Skip to content

Commit e3dccfb

Browse files
committed
📓 Updat README
1 parent 632569c commit e3dccfb

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

‎README.rst

+30
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,12 @@ I mean this module is using the CPython test cases for ``uuid`` module.
2525
You can consider this as a drop-in replacement.
2626

2727

28+
Incompatabe part:
29+
30+
* CPython 3.7 add ``UUID.is_safe`` attribute, we don't have it
31+
* some mismatch arguments are raise different exception, CPython raise ValueError, we raise TypeError, e.g. passing ``str`` to ``bytes`` argument
32+
33+
2834

2935
Why are you making this ?
3036
========================================
@@ -54,11 +60,35 @@ this is already usable for any use case that you want to use ``uuid`` .
5460

5561

5662

63+
How to use this ?
64+
========================================
65+
66+
.. code-block:: python
67+
68+
import su_uuid as uuid
69+
70+
uuid.uuid4()
71+
72+
73+
Exceptions:
74+
75+
.. code-block:: python
76+
77+
>>> import su_uuid as u
78+
>>> u.UUID('000z0000000000000000000000000000')
79+
Traceback (most recent call last):
80+
File "<stdin>", line 1, in <module>
81+
ValueError: UUID creation has error: Invalid character; found `z` (0x7a) at offset 3
82+
83+
84+
5785
Build
5886
========================================
5987

6088
.. code-block:: sh
6189
90+
rustup install nightly-2018-07-16
91+
rustup override set nightly-2018-07-16
6292
make wheel
6393
6494

0 commit comments

Comments
 (0)