Merge pull request #96 from akretion/add-sign-and-pdf

add sign_xml and to_pdf utility methods

nfelib/__init__.py

@@ -1,36 +1,40 @@
 # Copyright (C) 2023 Raphaël Valyi - Akretion <raphael.valyi@akretion.com.br>
 
 import os
+import warnings
+from os import environ
 from pathlib import Path
+from typing import Any, List, Optional
 
+import xsdata
 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
 
-
 __version__ = "2.0.4"
 
 
 class CommonMixin:
- """
- Generic validator class that is meant to be overriden for specific fiscal documents.
- """
+ """Generic helper class. Can be overriden for specific documents."""
 
  schema_path = None
  namespace = None
 
  @classmethod
- def from_xml(cls, xml):
+ def from_xml(cls, xml: str) -> Any:
+ """Parse xml and retun an instance of the class."""
  return XmlParser().from_string(xml)
 
  @classmethod
- def from_path(cls, path):
+ def from_path(cls, path: str) -> Any:
+ """Parse xml at given path and return an instance of the class."""
  xml = Path(path).read_text()
  return cls.from_xml(xml)
 
  @classmethod
- def schema_validation(cls, xml, schema_path=None):
+ def schema_validation(cls, xml: str, schema_path: Optional[str] = None) -> List:
+ """Validate xml against xsd schema at given path."""
  validation_messages = []
  doc_etree = etree.fromstring(xml.encode("utf-8"))
  if schema_path is None:
@@ -47,11 +51,11 @@ def schema_validation(cls, xml, schema_path=None):
  return validation_messages
 
  @classmethod
- def _get_package(cls):
+ def _get_package(cls) -> str:
  return cls.__module__.split("nfelib.")[1].split(".bindings")[0].split("_")[0]
 
  @classmethod
- def _get_schema_path(cls):
+ def _get_schema_path(cls) -> str:
  package = cls._get_package()
  if package == "nfe":
  return os.path.join(
@@ -61,43 +65,132 @@ def _get_schema_path(cls):
  "v4_0",
  "nfe_v4.00.xsd",
  )
- elif package == "nfse":
+ if package == "nfse":
  return os.path.join(
  os.path.dirname(__file__),
  "nfse",
  "schemas",
  "v1_0",
  "DPS_v1.00.xsd",
  )
- elif package == "mdfe":
+ if package == "mdfe":
  return os.path.join(
  os.path.dirname(__file__),
  "mdfe",
  "schemas",
  "v3_0",
  "mdfe_v3.00.xsd",
  )
- elif package == "cte":
+ if package == "cte":
  return os.path.join(
  os.path.dirname(__file__),
  "cte",
  "schemas",
  "v4_0",
  "cte_v4.00.xsd",
  )
- elif package == "bpe":
+ if package == "bpe":
  return os.path.join(
  os.path.dirname(__file__),
  "bpe",
  "schemas",
  "v1_0",
  "bpe_v1.00.xsd",
  )
+ return "undef"
+
+ @classmethod
+ def sign_xml(
+ cls,
+ xml: str,
+ pkcs12_data: Optional[bytes] = None,
+ pkcs12_password: Optional[str] = None,
+ doc_id: Optional[str] = None,
+ ) -> str:
+ """Sign xml file with pkcs12_data/pkcs12_password certificate.
+
+ Sometimes you need to test with a real certificate.
+ You can use the CERT_FILE and CERT_PASSWORD environment
+ variables to do tests with a real certificate data.
+ """
+ try:
+ from erpbrasil.assinatura import certificado as cert
+ from erpbrasil.assinatura.assinatura import Assinatura
+ except ImportError:
+ raise (RuntimeError("erpbrasil.assinatura package is not installed!"))
+
+ certificate = cert.Certificado(
+ arquivo=environ.get("CERT_FILE", pkcs12_data),
+ senha=environ.get("CERT_PASSWORD", pkcs12_password),
+ )
+ xml_etree = etree.fromstring(xml.encode("utf-8"))
+ return Assinatura(certificate).assina_xml2(xml_etree, doc_id)
+
+ @classmethod
+ def xmls_to_pdf(
+ self,
+ xml_list: List,
+ engine: str = "brazilfiscalreport",
+ image: Optional[str] = None, # (base64 image)
+ cfg_layout: str = "ICMS_IPI",
+ receipt_pos: str = "top",
+ ) -> bytes:
+ """Serialize a list of xmls strings (usually only one) to a pdf."""
+ xml_bytes_list = [
+ xml.encode() if isinstance(xml, str) else xml for xml in xml_list
+ ]
+ if engine == "brazilfiscalreport":
+ try:
+ from brazilfiscalreport.pdf_docs import Danfe
+ except ImportError:
+ raise (RuntimeError("brazilfiscalreport package is not installed!"))
+ return bytes(
+ Danfe(
+ xmls=xml_bytes_list,
+ image=image,
+ cfg_layout=cfg_layout,
+ receipt_pos=receipt_pos,
+ ).output(dest="S")
+ )
+ try:
+ from erpbrasil.edoc.pdf import base
+ except ImportError:
+ raise (RuntimeError("erpbrasil.edoc.pdf package is not installed!"))
+ return base.ImprimirXml.imprimir(string_xml=xml_bytes_list[0])
+
+ def to_xml(
+ self,
+ indent: str = " ",
+ ns_map: Optional[dict] = None,
+ pkcs12_data: Optional[bytes] = None,
+ pkcs12_password: Optional[str] = None,
+ doc_id: Optional[str] = None,
+ pretty_print: Optional[str] = None, # deprecated
+ ) -> str:
+ """Serialize binding as xml. You can fill the signature params to sign it."""
+
+ if xsdata.__version__.split(".")[0] in ("20", "21", "22", "23"):
+ serializer = XmlSerializer(
+ config=SerializerConfig(pretty_print=pretty_print)
+ )
  else:
- return "undef"
+ # deal with pretty_print deprecation in xsdata >= 24:
+ if indent is True: # (means pretty_print was passed)
+ indent = " "
+ if pretty_print:
+ warnings.warn(
+ "Setting `pretty_print` is deprecated, use `indent` instead",
+ DeprecationWarning,
+ )
+ indent = " "
+ elif pretty_print is False:
+ indent = None
+
+ if pkcs12_data:
+ indent = None
+
+ serializer = XmlSerializer(config=SerializerConfig(indent=indent))
 
- 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}
@@ -106,8 +199,39 @@ def to_xml(self, pretty_print=True, ns_map=None):
  else:
  package = self._get_package()
  ns_map = {None: f"http://www.portalfiscal.inf.br/{package}"}
- return serializer.render(obj=self, ns_map=ns_map)
+ xml = serializer.render(obj=self, ns_map=ns_map)
+ if pkcs12_data:
+ return self.sign_xml(xml, pkcs12_data, pkcs12_password, doc_id=doc_id)
+ return xml
 
- def validate_xml(self, schema_path=None):
+ def validate_xml(self, schema_path: Optional[str] = None) -> List:
+ """Serialize binding as xml, validate it and return possible errors."""
  xml = self.to_xml()
  return self.schema_validation(xml, schema_path)
+
+ def to_pdf(
+ self,
+ engine: str = "brazilfiscalreport",
+ image: Optional[str] = None, # (base64 image)
+ cfg_layout: str = "ICMS_IPI",
+ receipt_pos: str = "top",
+ pkcs12_data: Optional[bytes] = None,
+ pkcs12_password: Optional[str] = None,
+ doc_id: Optional[str] = None,
+ ) -> bytes:
+ """Serialize binding into pdf bytes."""
+ xml = self.to_xml()
+ if pkcs12_data:
+ xml = self.sign_xml(xml, pkcs12_data, pkcs12_password, doc_id)
+ return self.xmls_to_pdf([xml.encode()], engine, image, cfg_layout, receipt_pos)
+
+ # this was an attempt to keep the signature inside the
+ # binding before serializing it again. But at the moment it fails
+ # because xsdata will serialize the Signature elements with their namespaces.
+ # def sign(self, pkcs12_data: bytes = None, pkcs12_password: str = None,
+ # doc_id: str=None
+ # ) -> str:
+ # xml = self.to_xml(indent=None)
+ # signed_xml = self.sign_xml(xml, pkcs12_data, pkcs12_password, element)
+ # nfe = self.from_xml(signed_xml)
+ # return nfe

nfelib/v4_00/leiauteNFe_sub.py

@@ -3,11 +3,24 @@
 import sys
 import os
 from lxml import etree as etree_
+import warnings
 
 sys.path.append(os.path.dirname(__file__))
 import retEnviNFe as supermod
 
 
+warnings.warn(
+ (
+ "These nfelib 1.x bindings (nfelib.v4_00; generated with GenerateDS) "
+ "are deprecated and will be removed after 01/06/2024. "
+ "\nYou should use the nfelib 2.x xsdata bindings in nfelib.nfe.bindings "
+ "instead.\nYou can learn about the migration process here: "
+ "https://github.com/akretion/nfelib/issues/59"
+ ),
+ DeprecationWarning,
+)
+
+
 def parsexml_(infile, parser=None, keep_signature=False, **kwargs):
  "accepts both NFe and nfeProc documents"
 

setup.cfg

@@ -44,6 +44,8 @@ test =
  tox
  requests
  beautifulsoup4
+ erpbrasil.assinatura
+ brazilfiscalreport
 
 [flake8]
 exclude = tests/*

tests/fingerprint.txt

@@ -1,14 +1,14 @@
 {
  "nfe": [
  "https://www.nfe.fazenda.gov.br/portal/listaConteudo.aspx?tipoConteudo=BMPFMBoln3w=",
- "d3959ba8780305f3120e8dafcd95ba95"
+ "35ac8b0887d877858edcedc5748e132c"
  ],
  "cte": [
  "https://www.cte.fazenda.gov.br/portal/listaConteudo.aspx?tipoConteudo=0xlG1bdBass=",
- "d4721c910c48bedb1aabeca281a8d486"
+ "68c476b64cff31710cd6170170ae984c"
  ],
  "nfse": [
  "https://www.gov.br/nfse/pt-br/biblioteca/documentacao-tecnica",
  "788aaa5c930fbc91000a4b8d36311c0f"
  ]
-}
+}