mirror of
https://github.com/simonw/datasette.git
synced 2025-12-10 16:51:24 +01:00
Update docs for tilde rather than dash encoding, refs #1657
This commit is contained in:
parent
47151c23b4
commit
5c02664e4a
1 changed files with 16 additions and 16 deletions
|
|
@ -876,31 +876,31 @@ Utility function for calling ``await`` on a return value if it is awaitable, oth
|
|||
|
||||
.. autofunction:: datasette.utils.await_me_maybe
|
||||
|
||||
.. _internals_dash_encoding:
|
||||
.. _internals_tilde_encoding:
|
||||
|
||||
Dash encoding
|
||||
-------------
|
||||
Tilde encoding
|
||||
--------------
|
||||
|
||||
Datasette uses a custom encoding scheme in some places, called **dash encoding**. This is primarily used for table names and row primary keys, to avoid any confusion between ``/`` characters in those values and the Datasette URLs that reference them.
|
||||
Datasette uses a custom encoding scheme in some places, called **tilde encoding**. This is primarily used for table names and row primary keys, to avoid any confusion between ``/`` characters in those values and the Datasette URLs that reference them.
|
||||
|
||||
Dash encoding uses the same algorithm as `URL percent-encoding <https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding>`__, but with the ``-`` hyphen character used in place of ``%``.
|
||||
Tilde encoding uses the same algorithm as `URL percent-encoding <https://developer.mozilla.org/en-US/docs/Glossary/percent-encoding>`__, but with the ``~`` hyphen character used in place of ``%``.
|
||||
|
||||
Any character other than ``ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789_`` will be replaced by the numeric equivalent preceded by a hyphen. For example:
|
||||
Any character other than ``ABCDEFGHIJKLMNOPQRSTUVWXYZ abcdefghijklmnopqrstuvwxyz 0123456789_-`` will be replaced by the numeric equivalent preceded by a tilde. For example:
|
||||
|
||||
- ``/`` becomes ``-2F``
|
||||
- ``.`` becomes ``-2E``
|
||||
- ``%`` becomes ``-25``
|
||||
- ``-`` becomes ``-2D``
|
||||
- Space character becomes ``-20``
|
||||
- ``polls/2022.primary`` becomes ``polls-2F2022-2Eprimary``
|
||||
- ``/`` becomes ``~2F``
|
||||
- ``.`` becomes ``~2E``
|
||||
- ``%`` becomes ``~25``
|
||||
- ``~`` becomes ``~7E``
|
||||
- Space character becomes ``~20``
|
||||
- ``polls/2022.primary`` becomes ``polls~2F2022~2Eprimary``
|
||||
|
||||
.. _internals_utils_dash_encode:
|
||||
.. _internals_utils_tilde_encode:
|
||||
|
||||
.. autofunction:: datasette.utils.dash_encode
|
||||
.. autofunction:: datasette.utils.tilde_encode
|
||||
|
||||
.. _internals_utils_dash_decode:
|
||||
.. _internals_utils_tilde_decode:
|
||||
|
||||
.. autofunction:: datasette.utils.dash_decode
|
||||
.. autofunction:: datasette.utils.tilde_decode
|
||||
|
||||
.. _internals_tracer:
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue