Files
tryton/trytond/doc/ref/tools/misc.rst
T
Cédric Krier d0b8a38529 Find module paths using entry points
Closes #12900
(grafted from d9ef251eee77a95b3f0c5be9c6c036790072439f)

--HG--
branch : 7.0
2024-01-05 19:57:49 +01:00

71 lines
1.8 KiB
ReStructuredText

.. _ref-tools:
.. module:: trytond.tools
Miscellaneous
=============
.. function:: entry_points()
Return a collection of entry points.
.. function:: import_module(name)
Import the named Tryton module.
.. function:: file_open(name[, mode[, subdir[, encoding]]])
Open the named file in subdir from the root directory.
.. function:: find_path(name[, subdir])
Return the path of the named file in subdir from root directory.
.. function:: find_dir(name[, subdir])
Return the path of the named directory in subdir from root directory.
.. function:: pairwise_longest(iterable)
Return successive overlapping pairs taken from the input iterable.
The number of 2-tuples in the output iterator will be the number of inputs
and ends with the ``None``.
It will be empty if the input iterable has fewer than two values.
.. function:: resolve(name)
Resolve a dotted name to a global object.
.. method:: safe_join(directory, \*pathnames)
Safely join zero or more untrusted path components to a base directory to
avoid escaping the base directory.
.. function:: unescape_wildcard(string[, wildcards[, escape]])
Return the string without the wild card escapes.
.. function:: is_full_text(value[, escape])
Determine if the value can be used as full text search.
This is the case when the value starts and ends with a ``%`` or does not
contain any wild cards.
.. function:: likify(string[, escape])
Convert the string for full text if it does not contain any wild cards.
.. function:: sql_pairing(x, y)
Return an SQL expression that pairs SQL integers x and y.
.. function:: firstline(text)
Return first non-empty line of a text field.
.. function:: remove_forbidden_chars(value)
Return a copy of the string with forbidden char from
:class:`~trytond.model.fields.Char` replaced by space.