ldap-schema.rst 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  1. .. % $Id: ldap-schema.rst,v 1.4 2011/07/22 17:46:07 stroeder Exp $
  2. ********************************************
  3. :py:mod:`ldap.schema` Handling LDAPv3 schema
  4. ********************************************
  5. .. py:module:: ldap.schema
  6. This module deals with schema information usually retrieved from
  7. a special subschema subentry provided by the server.
  8. It is closely modeled along the directory information model described
  9. in the following RFC with which you should make yourself familiar
  10. when trying to use this module:
  11. .. seealso::
  12. :rfc:`4512` - Lightweight Directory Access Protocol (LDAP): Directory Information Models
  13. :py:mod:`ldap.schema.subentry` Processing LDAPv3 subschema subentry
  14. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  15. .. py:module:: ldap.schema.subentry
  16. .. py:data:: NOT_HUMAN_READABLE_LDAP_SYNTAXES
  17. Dictionary where the keys are the OIDs of LDAP syntaxes known to be
  18. not human-readable when displayed to a console without conversion
  19. and which cannot be decoded to a :py:data:`types.UnicodeType`.
  20. Functions
  21. =========
  22. .. autofunction:: ldap.schema.subentry.urlfetch
  23. Classes
  24. =======
  25. .. autoclass:: ldap.schema.subentry.SubSchema
  26. :members:
  27. :py:mod:`ldap.schema.models` Schema elements
  28. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  29. .. py:module:: ldap.schema.models
  30. .. autoclass:: ldap.schema.models.Entry
  31. :members:
  32. .. autoclass:: ldap.schema.models.SchemaElement
  33. :members:
  34. .. autoclass:: ldap.schema.models.AttributeType
  35. :members:
  36. .. autoclass:: ldap.schema.models.ObjectClass
  37. :members:
  38. .. autoclass:: ldap.schema.models.MatchingRule
  39. :members:
  40. .. autoclass:: ldap.schema.models.MatchingRuleUse
  41. :members:
  42. .. autoclass:: ldap.schema.models.DITContentRule
  43. :members:
  44. .. autoclass:: ldap.schema.models.NameForm
  45. :members:
  46. .. autoclass:: ldap.schema.models.DITStructureRule
  47. :members:
  48. .. _ldap.schema-example:
  49. Examples for ldap.schema
  50. ^^^^^^^^^^^^^^^^^^^^^^^^
  51. ::
  52. import ldap.schema