Skip to content

Commit 5094214

Browse files
committed
Update the table of formats.
1 parent 7925e87 commit 5094214

File tree

1 file changed

+31
-14
lines changed

1 file changed

+31
-14
lines changed

docs/validate.rst

Lines changed: 31 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -324,32 +324,49 @@ validation can be enabled by hooking in a format-checking object into an
324324
There are a number of default checkers that `FormatChecker`\s know how
325325
to validate. Their names can be viewed by inspecting the
326326
`FormatChecker.checkers` attribute. Certain checkers will only be
327-
available if an appropriate package is available for use. The available
328-
checkers, along with their requirement (if any,) are listed below.
327+
available if an appropriate package is available for use. The easiest way to
328+
ensure you have what is needed is to install ``jsonschema`` using the
329+
``format`` setuptools extra -- i.e.
330+
331+
.. code-block:: sh
332+
333+
$ pip install jsonschema[format]
334+
335+
which will install all of the below dependencies for all formats. The
336+
more specific list of available checkers, along with their requirement
337+
(if any,) are listed below.
329338

330339
.. note::
331340

332341
If the following packages are not installed when using a checker
333342
that requires it, validation will succeed without throwing an error,
334343
as specified by the JSON Schema specification.
335344

336-
========== ====================
337-
Checker Notes
338-
========== ====================
345+
===================== ====================
346+
Checker Notes
347+
===================== ====================
348+
color requires webcolors_
349+
date
350+
date-time requires strict-rfc3339_
351+
email
339352
hostname
353+
idn-hostname requires idna_
340354
ipv4
341-
ipv6 OS must have `socket.inet_pton` function
342-
email
343-
uri requires rfc3987_
344-
date-time requires strict-rfc3339_ [#]_
345-
date
346-
time
355+
ipv6 OS must have `socket.inet_pton` function
356+
iri requires rfc3987_
357+
iri-reference requires rfc3987_
358+
json-pointer requires jsonpointer_
347359
regex
348-
color requires webcolors_
349-
========== ====================
360+
relative-json-pointer requires jsonpointer_
361+
time requires strict-rfc3339_
362+
uri requires rfc3987_
363+
uri-reference requires rfc3987_
364+
===================== ====================
350365

351366

367+
.. _idna: https://pypi.org/pypi/idna/
368+
.. _jsonpointer: https://pypi.org/pypi/jsonpointer/
352369
.. _rfc3987: https://pypi.org/pypi/rfc3987/
370+
.. _rfc5322: https://tools.ietf.org/html/rfc5322#section-3.4.1
353371
.. _strict-rfc3339: https://pypi.org/pypi/strict-rfc3339/
354372
.. _webcolors: https://pypi.org/pypi/webcolors/
355-
.. _rfc5322: https://tools.ietf.org/html/rfc5322#section-3.4.1

0 commit comments

Comments
 (0)