Skip to content

Commit

Permalink
Update documentation and requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
brunato committed Feb 25, 2019
1 parent 1ae3ebd commit 4dc7714
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 15 deletions.
7 changes: 4 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
CHANGELOG
*********

`v1.0.10`_ (TBD)
================
* (XSD 1.1 features implementation completed)
`v1.0.10`_ (2019-02-25)
=======================
* Fixed Element type mismatch issue when apply *SafeXMLParser* to schema resources
* More XSD 1.1 features implemented (open content and versioning namespace are missing)

`v1.0.9`_ (2019-02-03)
======================
Expand Down
8 changes: 5 additions & 3 deletions doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,6 @@ Resource access API
.. autoattribute:: url
.. autoattribute:: base_url
.. autoattribute:: namespace
.. autoattribute:: parse
.. autoattribute:: iterparse
.. autoattribute:: fromstring

.. automethod:: copy
.. automethod:: tostring
Expand All @@ -159,6 +156,11 @@ Resource access API
.. automethod:: get_namespaces
.. automethod:: get_locations

.. automethod:: defusing
.. automethod:: parse
.. automethod:: iterparse
.. automethod:: fromstring


.. autofunction:: xmlschema.fetch_resource
.. autofunction:: xmlschema.fetch_schema
Expand Down
5 changes: 0 additions & 5 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -522,14 +522,9 @@ XML entity-based attacks protection

The XML data resource loading is protected using the `SafeXMLParser` class, a subclass of
the pure Python version of XMLParser that forbids the use of entities.

The protection is applied both to XSD schemas and to XML data. The usage of this feature is
regulated by the XMLSchema's argument *defuse*.
For default this argument has value *'remote'* that means the protection on XML data is
applied only to data loaded from remote. Other values for this argument can be *'always'*
and *'never'*.

The `SafeXMLParser` requires the usage of the pure Python module of ElementTree and this
involves the penalty that trees loaded by this parser can't be serialized with pickle,
that in Python 3 works with the C implementation of ElementTree.

2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Requirements for setup a development environment for the xmlschema package.
setuptools
tox
elementpath>=1.1.4
elementpath~=1.1.5
lxml
memory_profiler
pathlib2 # For Py27 tests on resources
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
setup(
name='xmlschema',
version='1.0.10',
install_requires=['elementpath==1.1.5'],
install_requires=['elementpath~=1.1.5'],
packages=['xmlschema'],
include_package_data=True,
author='Davide Brunato',
Expand Down
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ toxworkdir = {homedir}/.tox/xmlschema
[testenv]
deps =
lxml
elementpath>=1.1.5
elementpath~=1.1.5
commands = python xmlschema/tests/test_all.py {posargs}

[testenv:py27]
deps =
lxml
elementpath>=1.1.5
elementpath~=1.1.5
pathlib2
commands = python xmlschema/tests/test_all.py {posargs}

0 comments on commit 4dc7714

Please sign in to comment.