entrouvert
/
debian-factur-x
16
0
Fork 0
Code Issues Pull Requests 1 Releases Activity

Replace optparse by argparse (optparse is deprected) in all scripts under bin/ 

setup.py: declare compatibility with Python 3.8
This commit is contained in:
Alexis de Lattre 2021-03-30 21:58:45 +02:00 committed by Nicolas ROCHE
parent fd6be6a89f
commit a9e87e41e9
6 changed files with 176 additions and 199 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
bin/facturx-pdfextractxml
View File

@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
# Copyright 2017-2019 Alexis de Lattre <alexis.delattre@akretion.com>
from optparse import OptionParser
import argparse
import sys
from facturx import get_facturx_xml_from_pdf
from facturx.facturx import logger
@ -10,24 +10,13 @@ import logging
from os.path import isfile, isdir
__author__ = "Alexis de Lattre <alexis.delattre@akretion.com>"
__date__ = "August 2017"
__version__ = "0.1"
options = [
{'names': ('-l', '--log-level'), 'dest': 'log_level',
'action': 'store', 'default': 'info',
'help': "Set log level. Possible values: debug, info, warn, error. "
"Default value: info."},
{'names': ('-d', '--disable-xsd-check'), 'dest': 'disable_xsd_check',
'action': 'store_true', 'default': False,
'help': "De-activate XML Schema Definition check on Factur-X XML file "
"(the check is enabled by default)"},
]
__date__ = "March 2021"
__version__ = "0.2"
def main(options, arguments):
if options.log_level:
log_level = options.log_level.lower()
def main(args):
if args.log_level:
log_level = args.log_level.lower()
log_map = {
'debug': logging.DEBUG,
'info': logging.INFO,
@ -42,13 +31,8 @@ def main(options, arguments):
log_level, ', '.join(log_map.keys()))
sys.exit(1)
if len(arguments) != 2:
logger.error(
'This command requires 2 arguments (%d used). '
'Use --help to get the details.', len(arguments))
sys.exit(1)
pdf_filename = arguments[0]
out_xml_filename = arguments[1]
pdf_filename = args.facturx_file
out_xml_filename = args.xml_file_to_create
if not isfile(pdf_filename):
logger.error('Argument %s is not a filename', pdf_filename)
sys.exit(1)
@ -59,7 +43,7 @@ def main(options, arguments):
sys.exit(1)
pdf_file = open(pdf_filename, 'rb')
check_xsd = True
if options.disable_xsd_check:
if args.disable_xsd_check:
check_xsd = False
# The important line of code is below !
try:
@ -82,14 +66,24 @@ def main(options, arguments):
if __name__ == '__main__':
usage = "Usage: facturx-pdfextractxml <invoice.pdf> <factur-x_xml.xml>"
epilog = "Author: %s\n\nVersion: %s" % (__author__, __version__)
usage = "facturx-pdfextractxml <facturx_file> <xml_file_to_create>"
epilog = "Author: %s - Version: %s" % (__author__, __version__)
description = "This extracts the XML file from a Factur-X invoice."
parser = OptionParser(usage=usage, epilog=epilog, description=description)
for option in options:
param = option['names']
del option['names']
parser.add_option(*param, **option)
options, arguments = parser.parse_args()
sys.argv[:] = arguments
main(options, arguments)
parser = argparse.ArgumentParser(
usage=usage, epilog=epilog, description=description)
parser.add_argument(
'-l', '--log-level', dest="log_level", default='info',
help="Set log level. Possible values: debug, info, warn, error. "
"Default value: info.")
parser.add_argument(
'-d', '--disable-xsd-check', dest='disable_xsd_check',
action='store_true',
help="De-activate XML Schema Definition check on Factur-X XML file "
"(the check is enabled by default)")
parser.add_argument(
"facturx_file", help="PDF Factur-X file")
parser.add_argument(
"xml_file_to_create",
help="Filename of the XML file that will be extracted from the PDF")
args = parser.parse_args()
main(args)

159
bin/facturx-pdfgen
View File

@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
# Copyright 2017-2020 Alexis de Lattre <alexis.delattre@akretion.com>
from optparse import OptionParser
import argparse
import sys
from facturx import generate_facturx_from_file
from facturx.facturx import logger
@ -10,53 +10,13 @@ import logging
from os.path import isfile, isdir, basename
__author__ = "Alexis de Lattre <alexis.delattre@akretion.com>"
__date__ = "January 2020"
__version__ = "0.5"
options = [
{'names': ('-l', '--log-level'), 'dest': 'log_level',
'action': 'store', 'default': 'info',
'help': "Set log level. Possible values: debug, info, warn, error. "
"Default value: info."},
{'names': ('-d', '--disable-xsd-check'), 'dest': 'disable_xsd_check',
'action': 'store_true', 'default': False,
'help': "De-activate XML Schema Definition check on Factur-X XML file "
"(the check is enabled by default)"},
{'names': ('-n', '--facturx-level'), 'dest': 'facturx_level',
'action': 'store', 'default': 'autodetect',
'help': "Specify the Factur-X level of the XML file. "
"Default: autodetect. If you specify a particular level instead of "
"using autodetection, you will win a very small amount of time "
"(less than 1 millisecond). "
"Possible values: minimum, basicwl, basic, en16931."},
{'names': ('-a', '--meta-author'), 'dest': 'meta_author',
'action': 'store', 'default': False,
'help': "Specify the author for PDF metadata. Default: use the vendor "
"name extracted from the Factur-X XML file."},
{'names': ('-k', '--meta-keywords'), 'dest': 'meta_keywords',
'action': 'store', 'default': False,
'help': "Specify the keywords for PDF metadata. "
"Default: 'Invoice, Factur-X'."},
{'names': ('-t', '--meta-title'), 'dest': 'meta_title',
'action': 'store', 'default': False,
'help': "Specify the title of PDF metadata. "
"Default: generic English title with information extracted from "
"the Factur-X XML file such as: 'Akretion: Invoice I1242'"},
{'names': ('-s', '--meta-subject'), 'dest': 'meta_subject',
'action': 'store', 'default': False,
'help': "Specify the subject of PDF metadata. "
"Default: generic English subject with information extracted from the "
"Factur-X XML file such as: "
"'Factur-X invoice I1242 dated 2017-08-17 issued by Akretion'"},
{'names': ('-w', '--overwrite'), 'dest': 'overwrite',
'action': 'store_true', 'default': False,
'help': "Overwrite Factur-X invoice file if it already exists."},
]
__date__ = "March 2021"
__version__ = "0.6"
def main(options, arguments):
if options.log_level:
log_level = options.log_level.lower()
def main(args):
if args.log_level:
log_level = args.log_level.lower()
log_map = {
'debug': logging.DEBUG,
'info': logging.INFO,
@ -71,15 +31,10 @@ def main(options, arguments):
log_level, ', '.join(log_map.keys()))
sys.exit(1)
if len(arguments) < 3:
logger.error(
'This command requires at least 3 arguments (%d used). '
'Use --help to get the details.', len(arguments))
sys.exit(1)
pdf_filename = arguments[0]
xml_filename = arguments[1]
facturx_pdf_filename = arguments[2]
additional_attachment_filenames = arguments[3:]
pdf_filename = args.regular_pdf_file
xml_filename = args.facturx_xml
facturx_pdf_filename = args.facturx_pdf_file
additional_attachment_filenames = args.optional_attachments
for filename in [pdf_filename, xml_filename] + additional_attachment_filenames:
if not isfile(filename):
logger.error('Argument %s is not a filename', filename)
@ -91,22 +46,22 @@ def main(options, arguments):
sys.exit(1)
xml_file = open(xml_filename, 'rb')
check_xsd = True
if options.disable_xsd_check:
if args.disable_xsd_check:
check_xsd = False
pdf_metadata = None
if (
options.meta_author or
options.meta_keywords or
options.meta_title or
options.meta_subject):
args.meta_author or
args.meta_keywords or
args.meta_title or
args.meta_subject):
pdf_metadata = {
'author': options.meta_author,
'keywords': options.meta_keywords,
'title': options.meta_title,
'subject': options.meta_subject,
'author': args.meta_author,
'keywords': args.meta_keywords,
'title': args.meta_title,
'subject': args.meta_subject,
}
if isfile(facturx_pdf_filename):
if options.overwrite:
if args.overwrite:
logger.warning(
'File %s already exists. Overwriting it.',
facturx_pdf_filename)
@ -122,31 +77,71 @@ def main(options, arguments):
# The important line of code is below !
generate_facturx_from_file(
pdf_filename, xml_file, check_xsd=check_xsd,
facturx_level=options.facturx_level, pdf_metadata=pdf_metadata,
facturx_level=args.facturx_level, pdf_metadata=pdf_metadata,
output_pdf_file=facturx_pdf_filename, attachments=attachments)
except Exception as e:
logger.error('Factur-x lib call failed. Error: %s', e)
sys.exit(1)
if __name__ == '__main__':
usage = "Usage: facturx-pdfgen <regular_invoice.pdf> <factur-x_xml.xml> "\
"<facturx_invoice.pdf> <optional_attachment1.xyz> "\
"<optional_attach2.abc> [...]\n"\
"\nIf you use one of the --meta-* arguments, you should specify "\
"all the meta-* arguments because the default values for "\
"metadata only apply if none of the meta-* arguments are used."
epilog = "Author: %s\n\nVersion: %s" % (__author__, __version__)
usage = "facturx-pdfgen <regular_pdf_file> <facturx_xml> "\
"<facturx_pdf_file> <optional_attachments>"
epilog = "Author: %s - Version: %s" % (__author__, __version__)
description = "This script generate a Factur-X PDF invoice from a "\
"regular PDF/A invoice and a Factur-X XML file. "\
"It can also include additional embedded files in the PDF. "\
"To generate a valid PDF/A-3 invoice as requested by the "\
"Factur-X standard, you need to give a valid PDF/A "\
"regular invoice as input."
parser = OptionParser(usage=usage, epilog=epilog, description=description)
for option in options:
param = option['names']
del option['names']
parser.add_option(*param, **option)
options, arguments = parser.parse_args()
sys.argv[:] = arguments
main(options, arguments)
"regular invoice as input."\
"\n\nIf you use one of the --meta-* arguments, you should specify "\
"all the meta-* arguments because the default values for "\
"metadata only apply if none of the meta-* arguments are used."
parser = argparse.ArgumentParser(
usage=usage, epilog=epilog, description=description)
parser.add_argument(
'-l', '--log-level', dest='log_level', default='info',
help="Set log level. Possible values: debug, info, warn, error. "
"Default value: info.")
parser.add_argument(
'-d', '--disable-xsd-check', dest='disable_xsd_check',
action='store_true',
help="De-activate XML Schema Definition check on Factur-X XML file "
"(the check is enabled by default)")
parser.add_argument(
'-n', '--facturx-level', dest='facturx_level', default='autodetect',
help="Specify the Factur-X level of the XML file. "
"Default: autodetect. If you specify a particular level instead of "
"using autodetection, you will win a very small amount of time "
"(less than 1 millisecond). "
"Possible values: minimum, basicwl, basic, en16931, extended.")
parser.add_argument(
'-a', '--meta-author', dest='meta_author',
help="Specify the author for PDF metadata. Default: use the vendor "
"name extracted from the Factur-X XML file.")
parser.add_argument(
'-k', '--meta-keywords', dest='meta_keywords',
help="Specify the keywords for PDF metadata. "
"Default: 'Invoice, Factur-X'.")
parser.add_argument(
'-t', '--meta-title', dest='meta_title',
help="Specify the title of PDF metadata. "
"Default: generic English title with information extracted from "
"the Factur-X XML file such as: 'Akretion: Invoice I1242'")
parser.add_argument(
'-s', '--meta-subject', dest='meta_subject',
help="Specify the subject of PDF metadata. "
"Default: generic English subject with information extracted from the "
"Factur-X XML file such as: "
"'Factur-X invoice I1242 dated 2017-08-17 issued by Akretion'")
parser.add_argument(
'-w', '--overwrite', dest='overwrite', action='store_true',
help="Overwrite Factur-X invoice file if it already exists.")
parser.add_argument("regular_pdf_file", help="Regular PDF invoice")
parser.add_argument("facturx_xml", help="Factur-X XML file")
parser.add_argument("facturx_pdf_file", help="Generated Factur-X PDF file")
parser.add_argument(
"optional_attachments", nargs='*',
help="Optional list of additionnal attachments")
args = parser.parse_args()
main(args)

71
bin/facturx-webservice
View File

@ -11,7 +11,7 @@ from flask import Flask, request, send_file
from tempfile import NamedTemporaryFile
from facturx import generate_facturx_from_file
from facturx.facturx import logger as fxlogger
from optparse import OptionParser
import argparse
import logging
from logging.handlers import RotatingFileHandler
@ -61,52 +61,47 @@ def generate_facturx():
if __name__ == '__main__':
usage = "Usage: facturx_webservice.py [options]"
usage = "facturx_webservice.py [options]"
epilog = "Script written by Alexis de Lattre. "\
"Published under the BSD licence."
description = "This is a Flask application that exposes a REST "\
"webservice to generate a Factur-X invoice from a PDF file and an "\
"XML file."
options_def = [
{'names': ('-s', '--host'), 'dest': 'host', 'type': 'string',
'action': 'store', 'default': '127.0.0.1',
'help': "The hostname to listen on. Defaults to '127.0.0.1': "
"the webservice will only accept connexions from localhost. Use "
"'0.0.0.0' to have the webservice available from a remote host (but "
"it is recommended to listen on localhost and use an HTTPS proxy to "
"listen to remote connexions)."},
{'names': ('-p', '--port'), 'dest': 'port', 'type': 'int',
'action': 'store', 'default': 5000,
'help': "Port on which the webservice listens. You can select "
"any port between 1024 and 65535. Default port is 5000."},
{'names': ('-d', '--debug'), 'dest': 'debug',
'action': 'store_true', 'default': False,
'help': "Enable debug mode."},
{'names': ('-l', '--logfile'), 'dest': 'logfile', 'type': 'string',
'action': 'store', 'default': False,
'help': "Logs to a file instead of stdout."},
{'names': ('-n', '--loglevel'), 'dest': 'loglevel', 'type': 'string',
'action': 'store', 'default': 'info',
'help': "Log level. Possible values: critical, error, warning, "
"info (default), debug."},
]
parser = OptionParser(usage=usage, epilog=epilog, description=description)
for option in options_def:
param = option['names']
del option['names']
parser.add_option(*param, **option)
options, arguments = parser.parse_args()
if options.logfile:
parser = argparse.ArgumentParser(
usage=usage, epilog=epilog, description=description)
parser.add_argument(
'-s', '--host', dest='host', default='127.0.0.1',
help="The hostname to listen on. Defaults to '127.0.0.1': "
"the webservice will only accept connexions from localhost. Use "
"'0.0.0.0' to have the webservice available from a remote host (but "
"it is recommended to listen on localhost and use an HTTPS proxy to "
"listen to remote connexions).")
parser.add_argument(
'-p', '--port', dest='port', type=int, default=5000,
help="Port on which the webservice listens. You can select "
"any port between 1024 and 65535. Default port is 5000.")
parser.add_argument(
'-d', '--debug', dest='debug', action='store_true',
help="Enable debug mode.")
parser.add_argument(
'-l', '--logfile', dest='logfile',
help="Logs to a file instead of stdout.")
parser.add_argument(
'-n', '--loglevel', dest='loglevel', default='info',
help="Log level. Possible values: critical, error, warning, "
"info (default), debug.")
args = parser.parse_args()
if args.logfile:
formatter = logging.Formatter(
"[%(asctime)s] %(levelname)s %(message)s")
handler = RotatingFileHandler(options.logfile)
if options.loglevel == 'debug':
handler = RotatingFileHandler(args.logfile)
if args.loglevel == 'debug':
level = logging.DEBUG
elif options.loglevel == 'critical':
elif args.loglevel == 'critical':
level = logging.CRITICAL
elif options.loglevel == 'warning':
elif args.loglevel == 'warning':
level = logging.WARNING
elif options.loglevel == 'error':
elif args.loglevel == 'error':
level = logging.ERROR
else:
level = logging.INFO
@ -116,4 +111,4 @@ if __name__ == '__main__':
fxlogger.addHandler(handler)
app.logger.addHandler(handler)
app.logger.info('Start webservice to generate Factur-X invoices')
app.run(debug=options.debug, port=options.port, host=options.host)
app.run(debug=args.debug, port=args.port, host=args.host)

76
bin/facturx-xmlcheck
View File

@ -2,7 +2,7 @@
# -*- coding: utf-8 -*-
# Copyright 2017-2019 Alexis de Lattre <alexis.delattre@akretion.com>
from optparse import OptionParser
import argparse
import sys
from facturx import check_facturx_xsd
from facturx.facturx import logger
@ -10,32 +10,13 @@ import logging
from os.path import isfile
__author__ = "Alexis de Lattre <alexis.delattre@akretion.com>"
__date__ = "August 2017"
__version__ = "0.1"
options = [
{'names': ('-l', '--log-level'), 'dest': 'log_level',
'action': 'store', 'default': 'info',
'help': "Set log level. Possible values: debug, info, warn, error. "
"Default value: info."},
{'names': ('-f', '--flavor'), 'dest': 'flavor',
'action': 'store', 'default': 'autodetect',
'help': "Set XML flavor. "
"Possible values: factur-x, zugferd or autodetect. "
"Default value: autodetect."},
{'names': ('-n', '--facturx-level'), 'dest': 'facturx_level',
'action': 'store', 'default': 'autodetect',
'help': "Specify the Factur-X level of the XML file. "
"Default: autodetect. If you specify a particular level instead of "
"using autodetection, you will win a very small amount of time "
"(less than 1 millisecond). "
"Possible values: minimum, basicwl, basic, en16931."},
]
__date__ = "March 2021"
__version__ = "0.2"
def main(options, arguments):
if options.log_level:
log_level = options.log_level.lower()
def main(args):
if args.log_level:
log_level = args.log_level.lower()
log_map = {
'debug': logging.DEBUG,
'info': logging.INFO,
@ -50,12 +31,7 @@ def main(options, arguments):
log_level, ', '.join(log_map.keys()))
sys.exit(1)
if len(arguments) != 1:
logger.error(
'This command requires 1 argument (%d used). '
'Use --help to get the details.', len(arguments))
sys.exit(1)
xml_filename = arguments[0]
xml_filename = args.facturx_xml_file
if not isfile(xml_filename):
logger.error('%s is not a filename', xml_filename)
sys.exit(1)
@ -63,23 +39,37 @@ def main(options, arguments):
# The important line of code is below !
try:
check_facturx_xsd(
xml_file, flavor=options.flavor,
facturx_level=options.facturx_level)
xml_file, flavor=args.flavor,
facturx_level=args.facturx_level)
except Exception as e:
logger.error(e)
sys.exit(1)
if __name__ == '__main__':
usage = "Usage: facturx-xmlcheck <factur-x_xml.xml>\n"
epilog = "Author: %s\n\nVersion: %s" % (__author__, __version__)
usage = "facturx-xmlcheck <facturx_xml_file>"
epilog = "Author: %s - Version: %s" % (__author__, __version__)
description = "This script checks the Factur-X XML against the XML "\
"Schema Definition."
parser = OptionParser(usage=usage, epilog=epilog, description=description)
for option in options:
param = option['names']
del option['names']
parser.add_option(*param, **option)
options, arguments = parser.parse_args()
sys.argv[:] = arguments
main(options, arguments)
parser = argparse.ArgumentParser(
usage=usage, epilog=epilog, description=description)
parser.add_argument(
'-l', '--log-level', dest='log_level', default='info',
help="Set log level. Possible values: debug, info, warn, error. "
"Default value: info.")
parser.add_argument(
'-f', '--flavor', dest='flavor', default='autodetect',
help="Set XML flavor. Possible values: factur-x, zugferd or autodetect. "
"Default value: autodetect.")
parser.add_argument(
'-n', '--facturx-level', dest='facturx_level',
default='autodetect',
help="Specify the Factur-X level of the XML file. "
"Default: autodetect. If you specify a particular level instead of "
"using autodetection, you will win a very small amount of time "
"(less than 1 millisecond). "
"Possible values: minimum, basicwl, basic, en16931, extended.")
parser.add_argument(
"facturx_xml_file", help="Factur-X XML file to check")
args = parser.parse_args()
main(args)

1
facturx/facturx.py
View File

@ -570,6 +570,7 @@ def _facturx_update_metadata_add_attachment(
NameObject("/Names"): embedded_files_dict,
# show attachments when opening PDF
NameObject("/PageMode"): NameObject("/UseAttachments"),
# TODO add /Lang : createStringObject("fr-FR")
})
logger.debug('res_output_intents=%s', res_output_intents)
if res_output_intents:

4
setup.py
View File

@ -23,13 +23,15 @@ setup(
long_description=open('README.rst').read(),
license='BSD',
classifiers=[
'Development Status :: 4 - Beta',
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'License :: OSI Approved :: BSD License',
"Operating System :: OS Independent",
"Topic :: Office/Business :: Financial :: Accounting",
],
keywords='e-invoice ZUGFeRD Factur-X Chorus',
packages=find_packages(),