mirror of
https://github.com/python/cpython.git
synced 2025-08-01 15:43:13 +00:00
31fa41ed68
As discussed in #92611 and #92564 and as a followup to PR #92612 , this 3.11+ only PR uses the proper `deprecated-removed` role for the modules deprecated by PEP 593 (PEP-594) to clearly indicate to users that a removal version is planned and what it is, so they can prepare accordingly or voice any unanticipated impacts. Related to #92792 ; if we decide to backport that PR, the upgrade to using `deprecated-removed` on those functions can be moved to this one.
70 lines
2.1 KiB
ReStructuredText
70 lines
2.1 KiB
ReStructuredText
|
|
: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.
|
|
|
|
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.
|
|
|