diff options
| author | John T. Wodder II <git@varonathe.org> | 2020-05-15 21:17:49 +0000 |
|---|---|---|
| committer | John T. Wodder II <git@varonathe.org> | 2020-05-15 21:17:49 +0000 |
| commit | d6bcf5e89ef6a523c2476b249aba810af9808d8b (patch) | |
| tree | 8e9eb832b76a27c5de65dec924b72c3f4959c323 /docs | |
| parent | 130cbede42d3d351fc21bb35c18c1be7e108df46 (diff) | |
| download | external_python_setuptools-d6bcf5e89ef6a523c2476b249aba810af9808d8b.tar.gz external_python_setuptools-d6bcf5e89ef6a523c2476b249aba810af9808d8b.tar.bz2 external_python_setuptools-d6bcf5e89ef6a523c2476b249aba810af9808d8b.zip | |
Merge `literal_attr:` functionality into `attr:`
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/setuptools.txt | 27 |
1 files changed, 12 insertions, 15 deletions
diff --git a/docs/setuptools.txt b/docs/setuptools.txt index 3e616582..c37b7ec5 100644 --- a/docs/setuptools.txt +++ b/docs/setuptools.txt @@ -2193,7 +2193,7 @@ Metadata and options are set in the config sections of the same name. * In some cases, complex values can be provided in dedicated subsections for clarity. -* Some keys allow ``file:``, ``attr:``, ``literal_attr:``, ``find:``, and ``find_namespace:`` directives in +* Some keys allow ``file:``, ``attr:``, ``find:``, and ``find_namespace:`` directives in order to cover common usecases. * Unknown keys are ignored. @@ -2291,13 +2291,10 @@ Special directives: * ``attr:`` - Value is read from a module attribute. ``attr:`` supports callables and iterables; unsupported types are cast using ``str()``. -* ``literal_attr:`` — Like ``attr:``, except that the value is parsed using - ``ast.literal_eval()`` instead of by importing the module. This allows one - to specify an attribute of a module that imports one or more third-party - modules without having to install those modules first; as a downside, - ``literal_attr:`` only supports variables that are assigned constant - expressions, not more complex assignments like ``__version__ = - '.'.join(map(str, (VERSION_MAJOR, VERSION_MINOR, VERSION_PATCH)))``. + In order to support the common case of a literal value assigned to a variable + in a module containing (directly or indirectly) third-party imports, + ``attr:`` first tries to read the value from the module by examining the + module's AST. If that fails, ``attr:`` falls back to importing the module. * ``file:`` - Value is read from a list of files and then concatenated @@ -2314,14 +2311,14 @@ Metadata The aliases given below are supported for compatibility reasons, but their use is not advised. -============================== ================= ================================ =============== ===== -Key Aliases Type Minimum Version Notes -============================== ================= ================================ =============== ===== +============================== ================= ================= =============== ===== +Key Aliases Type Minimum Version Notes +============================== ================= ================= =============== ===== name str -version attr:, literal_attr:, file:, str 39.2.0 (1) +version attr:, file:, str 39.2.0 (1) url home-page str download_url download-url str -project_urls dict 38.3.0 +project_urls dict 38.3.0 author str author_email author-email str maintainer str @@ -2332,13 +2329,13 @@ license_file str license_files list-comma description summary file:, str long_description long-description file:, str -long_description_content_type str 38.6.0 +long_description_content_type str 38.6.0 keywords list-comma platforms platform list-comma provides list-comma requires list-comma obsoletes list-comma -============================== ================= ================================ =============== ===== +============================== ================= ================= =============== ===== .. note:: A version loaded using the ``file:`` directive must comply with PEP 440. |