Merge pull request #80 from akretion/validator

Validator

.xsdata.xml

@@ -10,6 +10,9 @@
  <PostponedAnnotations>false</PostponedAnnotations>
  <UnnestClasses>false</UnnestClasses>
  </Output>
+ <Extensions>
+ <Extension type="class" class=".*" import="nfelib.CommonMixin" prepend="false" applyIfDerived="false"/>
+ </Extensions>
  <Conventions>
  <ClassName case="pascalCase" safePrefix="type"/>
  <FieldName case="originalCase" safePrefix="value"/>

nfelib/__init__.py

@@ -1 +1,110 @@
-# nothing here
+# Copyright (C) 2023 Raphaël Valyi - Akretion <raphael.valyi@akretion.com.br>
+
+import os
+from pathlib import Path
+
+from lxml import etree
+from xsdata.formats.dataclass.parsers import XmlParser
+from xsdata.formats.dataclass.serializers import XmlSerializer
+from xsdata.formats.dataclass.serializers.config import SerializerConfig
+
+
+class CommonMixin:
+ """
+ Generic validator class that is meant to be overriden for specific fiscal documents.
+ """
+
+ schema_path = None
+ namespace = None
+
+ @classmethod
+ def from_xml(cls, xml):
+ return XmlParser().from_string(xml)
+
+ @classmethod
+ def from_path(cls, path):
+ xml = Path(path).read_text()
+ return cls.from_xml(xml)
+
+ @classmethod
+ def schema_validation(cls, xml, schema_path=None):
+ validation_messages = []
+ doc_etree = etree.fromstring(xml.encode("utf-8"))
+ if schema_path is None:
+ if cls.schema_path is not None:
+ schema_path = cls.schema_path
+ else:
+ schema_path = cls._get_schema_path()
+ xmlschema_doc = etree.parse(schema_path)
+ parser = etree.XMLSchema(xmlschema_doc)
+
+ if not parser.validate(doc_etree):
+ for e in parser.error_log:
+ validation_messages.append(e.message)
+ return validation_messages
+
+ @classmethod
+ def _get_package(cls):
+ return cls.__module__.split("nfelib.")[1].split(".bindings")[0].split("_")[0]
+
+ @classmethod
+ def _get_schema_path(cls):
+ package = cls._get_package()
+ if package == "nfe":
+ return os.path.join(
+ os.path.dirname(__file__),
+ "nfe",
+ "schemas",
+ "v4_0",
+ "nfe_v4.00.xsd",
+ )
+ elif package == "nfse":
+ return os.path.join(
+ os.path.dirname(__file__),
+ "nfse",
+ "schemas",
+ "v1_0",
+ "DPS_v1.00.xsd",
+ )
+ elif package == "mdfe":
+ return os.path.join(
+ os.path.dirname(__file__),
+ "mdfe",
+ "schemas",
+ "v3_0",
+ "mdfe_v3.00.xsd",
+ )
+ elif package == "cte":
+ return os.path.join(
+ os.path.dirname(__file__),
+ "cte",
+ "schemas",
+ "v4_0",
+ "cte_v4.00.xsd",
+ )
+ elif package == "bpe":
+ return os.path.join(
+ os.path.dirname(__file__),
+ "bpe",
+ "schemas",
+ "v1_0",
+ "bpe_v1.00.xsd",
+ )
+ else:
+ return "undef"
+
+ def to_xml(self, pretty_print=True, ns_map=None):
+ serializer = XmlSerializer(SerializerConfig(pretty_print=pretty_print))
+ if ns_map is None:
+ if self.namespace:
+ ns_map = {None: self.namespace}
+ elif hasattr(self.Meta, "namespace"):
+ ns_map = {None: self.Meta.namespace}
+ else:
+ package = self._get_package()
+ ns_map = {None: f"http://www.portalfiscal.inf.br/{package}"}
+ return serializer.render(obj=self, ns_map=ns_map)
+
+ def validate_xml(self, schema_path=None):
+ xml = self.to_xml()
+ return self.schema_validation(xml, schema_path)

nfelib/bpe/bindings/v1_0/__init__.py

@@ -1,4 +1,4 @@
-"""This file was generated by xsdata, v23.6, on 2023-06-27 01:20:43
+"""This file was generated by xsdata, v23.6, on 2023-06-28 18:36:39
 
 Generator: DataclassGenerator
 See: https://xsdata.readthedocs.io/