Francois10

.flake8

@@ -1,9 +1,13 @@
 [flake8]
 select = B,B9,C,D,DAR,E,F,N,RST,S,W
-ignore = E203,E501,RST201,RST203,RST301,W503
+ignore = D401,E203,E501,RST201,RST203,RST301,RST305,W503
 max-line-length = 120
 max-complexity = 10
 docstring-convention = numpy
-per-file-ignores = tests/*:S101,S106,F403,F405,F841 pypdf_table_extraction/*:D100,D103,D104,F401,W0611,C0114
+per-file-ignores = tests/*:B950,D100,D102,D103,D104,D401,D101,D200,S101,S106,F403,F405,F841
+    pypdf_table_extraction/*:D100,D103,D104,F401,W0611,C0114 docs/*:D100,D101
+    __init__.py:D100,D103,D104,F401
+    __version__.py:D100
+    __main__.py:D100,D103
 rst-roles = class,const,func,meth,mod,ref
 rst-directives = deprecated

camelot/__main__.py

@@ -1,3 +1,5 @@
+"""Initialize pypdf_table_extraction, formerly known as Camelot."""
+
 __all__ = ("main",)
 
 

camelot/backends/__init__.py

@@ -1 +1,3 @@
+"""pypdf_table_extraction offers multiple backends to convert the PDFs to images so it can be analyzed by opencv."""
+
 from .image_conversion import ImageConversionBackend

camelot/backends/ghostscript_backend.py

@@ -1,6 +1,26 @@
+"""Creates a ghostscript backend class to convert a pdf to a png file."""
+
+
 class GhostscriptBackend:
+    """Classmethod to create GhostscriptScriptBackend."""
 
     def convert(self, pdf_path, png_path, resolution=300):
+        """Convert a PDF to a PNG image using Ghostscript .
+
+        Parameters
+        ----------
+        pdf_path : str
+            [description]
+        png_path : str
+            [description]
+        resolution : int, optional
+            [description], by default 300
+
+        Raises
+        ------
+        OSError
+            [description]
+        """
         try:
             import ghostscript
         except RuntimeError:

camelot/backends/image_conversion.py

@@ -1,3 +1,5 @@
+"""Classes tand functions for the ImageConversionBackend backends."""
+
 from .ghostscript_backend import GhostscriptBackend
 from .poppler_backend import PopplerBackend
 
@@ -6,15 +8,47 @@
 
 
 class ImageConversionBackend:
+    """Classes the ImageConversionBackend backend."""
+
     def __init__(self, backend="poppler", use_fallback=True):
+        """Initialize the conversion backend .
+
+        Parameters
+        ----------
+        backend : str, optional
+            [description], by default "poppler"
+        use_fallback : bool, optional
+            [description], by default True
+
+        Raises
+        ------
+        ValueError
+            [description]
+        """
         if backend not in BACKENDS.keys():
-            raise ValueError(f"Image conversion backend '{backend}' not supported")
+            raise ValueError(f"Image conversion backend {backend!r} not supported")
 
         self.backend = backend
         self.use_fallback = use_fallback
         self.fallbacks = list(filter(lambda x: x != backend, BACKENDS.keys()))
 
     def convert(self, pdf_path, png_path):
+        """Convert PDF to png_path.
+
+        Parameters
+        ----------
+        pdf_path : str
+            Path where to read the pdf file.
+        png_path : str
+            Path where to save png file.
+
+        Raises
+        ------
+        type
+            [description]
+        type
+            [description]
+        """
         try:
             converter = BACKENDS[self.backend]()
             converter.convert(pdf_path, png_path)
@@ -28,12 +62,12 @@ def convert(self, pdf_path, png_path):
                         converter.convert(pdf_path, png_path)
                     except Exception as e:
                         raise type(e)(
-                            str(e) + f" with image conversion backend '{fallback}'"
+                            str(e) + f" with image conversion backend {fallback!r}"
                         ).with_traceback(sys.exc_info()[2])
                         continue
                     else:
                         break
             else:
                 raise type(e)(
-                    str(e) + f" with image conversion backend '{self.backend}'"
+                    str(e) + f" with image conversion backend {self.backend!r}"
                 ).with_traceback(sys.exc_info()[2])

camelot/backends/poppler_backend.py

@@ -1,3 +1,13 @@
+"""Creates a poppler backend class to convert a pdf to a png file.
+
+Raises
+------
+OSError
+    [description]
+ValueError
+    [description]
+"""
+
 import os
 import shutil
 import subprocess
@@ -8,7 +18,25 @@
 
 
 class PopplerBackend:
+    """Classmethod to create a poplerBackendBackend class."""
+
     def convert(self, pdf_path, png_path):
+        """Convert PDF to png.
+
+        Parameters
+        ----------
+        pdf_path : str
+            Path where to read the pdf file.
+        png_path : str
+            Path where to save png file.
+
+        Raises
+        ------
+        OSError
+            [description]
+        ValueError
+            [description]
+        """
         pdftopng_executable = shutil.which("pdftopng", path=path)
         if pdftopng_executable is None:
             raise OSError(

camelot/cli.py

@@ -1,3 +1,5 @@
+"""Implementation of the command line interface."""
+
 import logging
 
 import click
@@ -20,10 +22,14 @@
 
 
 class Config:
+    """Class method for creating a new class."""
+
     def __init__(self):
+        """Initialize the configuration."""
         self.config = {}
 
     def set_config(self, key, value):
+        """Set a configuration value for a given key."""
         self.config[key] = value
 
 
@@ -81,7 +87,7 @@ def set_config(self, key, value):
 )
 @click.pass_context
 def cli(ctx, *args, **kwargs):
-    """pypdf_table_extraction: PDF Table Extraction for Humans"""
+    """pypdf_table_extraction: PDF Table Extraction for Humans."""
     ctx.obj = Config()
     for key, value in kwargs.items():
         ctx.obj.set_config(key, value)
@@ -325,3 +331,185 @@ def stream(c, *args, **kwargs):
             plt.show()
     else:
         tables.export(output, f=f, compress=compress)
+
+
+@cli.command("hybrid")
+@click.option(
+    "-R",
+    "--table_regions",
+    default=[],
+    multiple=True,
+    help="Page regions to analyze. Example: x1,y1,x2,y2"
+    " where x1, y1 -> left-top and x2, y2 -> right-bottom.",
+)
+@click.option(
+    "-T",
+    "--table_areas",
+    default=[],
+    multiple=True,
+    help="Table areas to process. Example: x1,y1,x2,y2"
+    " where x1, y1 -> left-top and x2, y2 -> right-bottom.",
+)
+@click.option(
+    "-C",
+    "--columns",
+    default=[],
+    multiple=True,
+    help="X coordinates of column separators.",
+)
+@click.option(
+    "-e",
+    "--edge_tol",
+    default=50,
+    help="Tolerance parameter" " for extending textedges vertically.",
+)
+@click.option(
+    "-r",
+    "--row_tol",
+    default=2,
+    help="Tolerance parameter" " used to combine text vertically, to generate rows.",
+)
+@click.option(
+    "-c",
+    "--column_tol",
+    default=0,
+    help="Tolerance parameter"
+    " used to combine text horizontally, to generate columns.",
+)
+@click.option(
+    "-plot",
+    "--plot_type",
+    type=click.Choice(["text", "grid", "contour", "textedge"]),
+    help="Plot elements found on PDF page for visual debugging.",
+)
+@click.argument("filepath", type=click.Path(exists=True))
+@pass_config
+def hybrid(c, *args, **kwargs):
+    """Use spaces between text to parse the table."""
+    conf = c.config
+    pages = conf.pop("pages")
+    output = conf.pop("output")
+    f = conf.pop("format")
+    compress = conf.pop("zip")
+    quiet = conf.pop("quiet")
+    plot_type = kwargs.pop("plot_type")
+    filepath = kwargs.pop("filepath")
+    kwargs.update(conf)
+
+    table_regions = list(kwargs["table_regions"])
+    kwargs["table_regions"] = None if not table_regions else table_regions
+    table_areas = list(kwargs["table_areas"])
+    kwargs["table_areas"] = None if not table_areas else table_areas
+    columns = list(kwargs["columns"])
+    kwargs["columns"] = None if not columns else columns
+
+    if plot_type is not None:
+        if not _HAS_MPL:
+            raise ImportError("matplotlib is required for plotting.")
+    else:
+        if output is None:
+            raise click.UsageError("Please specify output file path using --output")
+        if f is None:
+            raise click.UsageError("Please specify output file format using --format")
+
+    tables = read_pdf(
+        filepath, pages=pages, flavor="hybrid", suppress_stdout=quiet, **kwargs
+    )
+    click.echo(f"Found {tables.n} tables")
+    if plot_type is not None:
+        for table in tables:
+            plot(table, kind=plot_type)
+            plt.show()
+    else:
+        tables.export(output, f=f, compress=compress)
+
+
+@cli.command("network")
+@click.option(
+    "-R",
+    "--table_regions",
+    default=[],
+    multiple=True,
+    help="Page regions to analyze. Example: x1,y1,x2,y2"
+    " where x1, y1 -> left-top and x2, y2 -> right-bottom.",
+)
+@click.option(
+    "-T",
+    "--table_areas",
+    default=[],
+    multiple=True,
+    help="Table areas to process. Example: x1,y1,x2,y2"
+    " where x1, y1 -> left-top and x2, y2 -> right-bottom.",
+)
+@click.option(
+    "-C",
+    "--columns",
+    default=[],
+    multiple=True,
+    help="X coordinates of column separators.",
+)
+@click.option(
+    "-e",
+    "--edge_tol",
+    default=50,
+    help="Tolerance parameter" " for extending textedges vertically.",
+)
+@click.option(
+    "-r",
+    "--row_tol",
+    default=2,
+    help="Tolerance parameter" " used to combine text vertically, to generate rows.",
+)
+@click.option(
+    "-c",
+    "--column_tol",
+    default=0,
+    help="Tolerance parameter"
+    " used to combine text horizontally, to generate columns.",
+)
+@click.option(
+    "-plot",
+    "--plot_type",
+    type=click.Choice(["text", "grid", "contour", "textedge"]),
+    help="Plot elements found on PDF page for visual debugging.",
+)
+@click.argument("filepath", type=click.Path(exists=True))
+@pass_config
+def network(c, *args, **kwargs):
+    """Use spaces between text to parse the table."""
+    conf = c.config
+    pages = conf.pop("pages")
+    output = conf.pop("output")
+    f = conf.pop("format")
+    compress = conf.pop("zip")
+    quiet = conf.pop("quiet")
+    plot_type = kwargs.pop("plot_type")
+    filepath = kwargs.pop("filepath")
+    kwargs.update(conf)
+
+    table_regions = list(kwargs["table_regions"])
+    kwargs["table_regions"] = None if not table_regions else table_regions
+    table_areas = list(kwargs["table_areas"])
+    kwargs["table_areas"] = None if not table_areas else table_areas
+    columns = list(kwargs["columns"])
+    kwargs["columns"] = None if not columns else columns
+
+    if plot_type is not None:
+        if not _HAS_MPL:
+            raise ImportError("matplotlib is required for plotting.")
+    else:
+        if output is None:
+            raise click.UsageError("Please specify output file path using --output")
+        if f is None:
+            raise click.UsageError("Please specify output file format using --format")
+
+    tables = read_pdf(
+        filepath, pages=pages, flavor="network", suppress_stdout=quiet, **kwargs
+    )
+    click.echo(f"Found {tables.n} tables")
+    if plot_type is not None:
+        for table in tables:
+            plot(table, kind=plot_type)
+            plt.show()
+    else:
+        tables.export(output, f=f, compress=compress)