diff options
| author | Victor Stinner <vstinner@python.org> | 2023-05-24 22:08:36 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-05-24 22:08:36 (GMT) |
| commit | 17e1fe0f9ba87eb170493daa0a4de207425195fd (patch) | |
| tree | db9e645358037bcec78ab5f92ff53a1cb49e691a /Doc/library/nis.rst | |
| parent | b1cb30ec8639e4e65f62e8f6cd44e979640431c8 (diff) | |
| download | cpython-17e1fe0f9ba87eb170493daa0a4de207425195fd.zip cpython-17e1fe0f9ba87eb170493daa0a4de207425195fd.tar.gz cpython-17e1fe0f9ba87eb170493daa0a4de207425195fd.tar.bz2 | |
gh-104773: PEP 594: Remove the nis module (#104897)
Diffstat (limited to 'Doc/library/nis.rst')
| -rw-r--r-- | Doc/library/nis.rst | 72 |
1 files changed, 0 insertions, 72 deletions
diff --git a/Doc/library/nis.rst b/Doc/library/nis.rst deleted file mode 100644 index 3fa7916..0000000 --- a/Doc/library/nis.rst +++ /dev/null @@ -1,72 +0,0 @@ - -:mod:`nis` --- Interface to Sun's NIS (Yellow Pages) -==================================================== - -.. module:: nis - :platform: Unix - :synopsis: Interface to Sun's NIS (Yellow Pages) library. - :deprecated: - -.. moduleauthor:: Fred Gansevles <Fred.Gansevles@cs.utwente.nl> -.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il> - -.. deprecated-removed:: 3.11 3.13 - The :mod:`nis` module is deprecated - (see :pep:`PEP 594 <594#nis>` for details). - --------------- - -The :mod:`nis` module gives a thin wrapper around the NIS library, useful for -central administration of several hosts. - -Because NIS exists only on Unix systems, this module is only available for Unix. - -.. include:: ../includes/wasm-notavail.rst - -The :mod:`nis` module defines the following functions: - - -.. function:: match(key, mapname, domain=default_domain) - - Return the match for *key* in map *mapname*, or raise an error - (:exc:`nis.error`) if there is none. Both should be strings, *key* is 8-bit - clean. Return value is an arbitrary array of bytes (may contain ``NULL`` and - other joys). - - Note that *mapname* is first checked if it is an alias to another name. - - The *domain* argument allows overriding the NIS domain used for the lookup. If - unspecified, lookup is in the default NIS domain. - - -.. function:: cat(mapname, domain=default_domain) - - Return a dictionary mapping *key* to *value* such that ``match(key, - mapname)==value``. Note that both keys and values of the dictionary are - arbitrary arrays of bytes. - - Note that *mapname* is first checked if it is an alias to another name. - - The *domain* argument allows overriding the NIS domain used for the lookup. If - unspecified, lookup is in the default NIS domain. - - -.. function:: maps(domain=default_domain) - - Return a list of all valid maps. - - The *domain* argument allows overriding the NIS domain used for the lookup. If - unspecified, lookup is in the default NIS domain. - - -.. function:: get_default_domain() - - Return the system default NIS domain. - - -The :mod:`nis` module defines the following exception: - -.. exception:: error - - An error raised when a NIS function returns an error code. - |