From 591cfd529105bc27e648e5bca59672d1dfc1bb99 Mon Sep 17 00:00:00 2001 From: Vinayak Mehta Date: Wed, 12 Dec 2018 10:15:04 +0530 Subject: [PATCH] Change kwarg name --- HISTORY.md | 2 +- camelot/cli.py | 10 +++++----- camelot/handlers.py | 8 ++++---- camelot/io.py | 8 ++++---- camelot/parsers/lattice.py | 4 ++-- camelot/parsers/stream.py | 4 ++-- tests/test_errors.py | 14 +++++++++++++- 7 files changed, 31 insertions(+), 19 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 56c7fc7..851a71d 100755 --- a/HISTORY.md +++ b/HISTORY.md @@ -7,7 +7,7 @@ master **Improvements** * [#207](https://github.com/socialcopsdev/camelot/issues/207) Add a plot type for Stream text edges and detected table areas. [#224](https://github.com/socialcopsdev/camelot/pull/224) by Vinayak Mehta. -* [#204](https://github.com/socialcopsdev/camelot/issues/204) `suppress_warnings` is now called `verbose`. By default, all logs and warnings will be printed. [#225](https://github.com/socialcopsdev/camelot/pull/225) by Vinayak Mehta. +* [#204](https://github.com/socialcopsdev/camelot/issues/204) `suppress_warnings` is now called `suppress_stdout`. [#225](https://github.com/socialcopsdev/camelot/pull/225) by Vinayak Mehta. **Bugfixes** diff --git a/camelot/cli.py b/camelot/cli.py index f304670..e978a3c 100644 --- a/camelot/cli.py +++ b/camelot/cli.py @@ -30,7 +30,7 @@ pass_config = click.make_pass_decorator(Config) @click.group() @click.version_option(version=__version__) -@click.option('-v', '--verbose', is_flag=True, help='Verbose.') +@click.option('-q', '--quiet', is_flag=False, help='Suppress logs and warnings.') @click.option('-p', '--pages', default='1', help='Comma-separated page numbers.' ' Example: 1,3,4 or 1,4-end.') @click.option('-pw', '--password', help='Password for decryption.') @@ -96,7 +96,7 @@ def lattice(c, *args, **kwargs): output = conf.pop('output') f = conf.pop('format') compress = conf.pop('zip') - verbose = conf.pop('verbose') + quiet = conf.pop('quiet') plot_type = kwargs.pop('plot_type') filepath = kwargs.pop('filepath') kwargs.update(conf) @@ -117,7 +117,7 @@ def lattice(c, *args, **kwargs): raise click.UsageError('Please specify output file format using --format') tables = read_pdf(filepath, pages=pages, flavor='lattice', - verbose=verbose, **kwargs) + suppress_stdout=quiet, **kwargs) click.echo('Found {} tables'.format(tables.n)) if plot_type is not None: for table in tables: @@ -149,7 +149,7 @@ def stream(c, *args, **kwargs): output = conf.pop('output') f = conf.pop('format') compress = conf.pop('zip') - verbose = conf.pop('verbose') + quiet = conf.pop('quiet') plot_type = kwargs.pop('plot_type') filepath = kwargs.pop('filepath') kwargs.update(conf) @@ -169,7 +169,7 @@ def stream(c, *args, **kwargs): raise click.UsageError('Please specify output file format using --format') tables = read_pdf(filepath, pages=pages, flavor='stream', - verbose=verbose, **kwargs) + suppress_stdout=quiet, **kwargs) click.echo('Found {} tables'.format(tables.n)) if plot_type is not None: for table in tables: diff --git a/camelot/handlers.py b/camelot/handlers.py index 619a5c1..a312131 100644 --- a/camelot/handlers.py +++ b/camelot/handlers.py @@ -125,7 +125,7 @@ class PDFHandler(object): with open(fpath, 'wb') as f: outfile.write(f) - def parse(self, flavor='lattice', verbose=True, **kwargs): + def parse(self, flavor='lattice', suppress_stdout=False, **kwargs): """Extracts tables by calling parser.get_tables on all single page PDFs. @@ -134,8 +134,8 @@ class PDFHandler(object): flavor : str (default: 'lattice') The parsing method to use ('lattice' or 'stream'). Lattice is used by default. - verbose : str (default: True) - Print all logs and warnings. + suppress_stdout : str (default: False) + Suppress logs and warnings. kwargs : dict See camelot.read_pdf kwargs. @@ -153,6 +153,6 @@ class PDFHandler(object): for p in self.pages] parser = Lattice(**kwargs) if flavor == 'lattice' else Stream(**kwargs) for p in pages: - t = parser.extract_tables(p, verbose=verbose) + t = parser.extract_tables(p, suppress_stdout=suppress_stdout) tables.extend(t) return TableList(tables) diff --git a/camelot/io.py b/camelot/io.py index 2bf5965..4b436ff 100644 --- a/camelot/io.py +++ b/camelot/io.py @@ -6,7 +6,7 @@ from .utils import validate_input, remove_extra def read_pdf(filepath, pages='1', password=None, flavor='lattice', - verbose=True, **kwargs): + suppress_stdout=False, **kwargs): """Read PDF and return extracted tables. Note: kwargs annotated with ^ can only be used with flavor='stream' @@ -24,7 +24,7 @@ def read_pdf(filepath, pages='1', password=None, flavor='lattice', flavor : str (default: 'lattice') The parsing method to use ('lattice' or 'stream'). Lattice is used by default. - verbose : bool, optional (default: True) + suppress_stdout : bool, optional (default: True) Print all logs and warnings. table_areas : list, optional (default: None) List of table area strings of the form x1,y1,x2,y2 @@ -92,11 +92,11 @@ def read_pdf(filepath, pages='1', password=None, flavor='lattice', " Use either 'lattice' or 'stream'") with warnings.catch_warnings(): - if not verbose: + if suppress_stdout: warnings.simplefilter("ignore") validate_input(kwargs, flavor=flavor) p = PDFHandler(filepath, pages=pages, password=password) kwargs = remove_extra(kwargs, flavor=flavor) - tables = p.parse(flavor=flavor, verbose=verbose, **kwargs) + tables = p.parse(flavor=flavor, suppress_stdout=suppress_stdout, **kwargs) return tables diff --git a/camelot/parsers/lattice.py b/camelot/parsers/lattice.py index ff8b5e1..cca6789 100644 --- a/camelot/parsers/lattice.py +++ b/camelot/parsers/lattice.py @@ -345,9 +345,9 @@ class Lattice(BaseParser): return table - def extract_tables(self, filename, verbose=True): + def extract_tables(self, filename, suppress_stdout=False): self._generate_layout(filename) - if verbose: + if not suppress_stdout: logger.info('Processing {}'.format(os.path.basename(self.rootname))) if not self.horizontal_text: diff --git a/camelot/parsers/stream.py b/camelot/parsers/stream.py index 6713635..0fbae71 100644 --- a/camelot/parsers/stream.py +++ b/camelot/parsers/stream.py @@ -384,9 +384,9 @@ class Stream(BaseParser): return table - def extract_tables(self, filename, verbose=True): + def extract_tables(self, filename, suppress_stdout=False): self._generate_layout(filename) - if verbose: + if not suppress_stdout: logger.info('Processing {}'.format(os.path.basename(self.rootname))) if not self.horizontal_text: diff --git a/tests/test_errors.py b/tests/test_errors.py index 07e052e..e0dc24a 100755 --- a/tests/test_errors.py +++ b/tests/test_errors.py @@ -50,13 +50,25 @@ def test_no_tables_found(): assert str(e.value) == 'No tables found on page-1' +def test_no_tables_found_logs_suppressed(): + filename = os.path.join(testdir, 'foo.pdf') + with warnings.catch_warnings(): + # the test should fail if any warning is thrown + warnings.simplefilter('error') + try: + tables = camelot.read_pdf(filename, suppress_stdout=True) + except Warning as e: + warning_text = str(e) + pytest.fail('Unexpected warning: {}'.format(warning_text)) + + def test_no_tables_found_warnings_suppressed(): filename = os.path.join(testdir, 'blank.pdf') with warnings.catch_warnings(): # the test should fail if any warning is thrown warnings.simplefilter('error') try: - tables = camelot.read_pdf(filename, verbose=False) + tables = camelot.read_pdf(filename, suppress_stdout=True) except Warning as e: warning_text = str(e) pytest.fail('Unexpected warning: {}'.format(warning_text))