# {py:mod}`dawsonia.io._pdf`

```{py:module} dawsonia.io._pdf
```

```{autodoc2-docstring} dawsonia.io._pdf
:allowtitles:
```

## Module Contents

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`read_pdf_book <dawsonia.io._pdf.read_pdf_book>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.read_pdf_book
    :summary:
    ```
* - {py:obj}`log_pdf_metadata <dawsonia.io._pdf.log_pdf_metadata>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.log_pdf_metadata
    :summary:
    ```
* - {py:obj}`check_pdf_page_range <dawsonia.io._pdf.check_pdf_page_range>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.check_pdf_page_range
    :summary:
    ```
* - {py:obj}`station_name_from_pdf <dawsonia.io._pdf.station_name_from_pdf>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.station_name_from_pdf
    :summary:
    ```
* - {py:obj}`year_from_pdf <dawsonia.io._pdf.year_from_pdf>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.year_from_pdf
    :summary:
    ```
* - {py:obj}`get_pdf_pages <dawsonia.io._pdf.get_pdf_pages>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.get_pdf_pages
    :summary:
    ```
* - {py:obj}`set_skip_dict <dawsonia.io._pdf.set_skip_dict>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.set_skip_dict
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`logger <dawsonia.io._pdf.logger>`
  - ```{autodoc2-docstring} dawsonia.io._pdf.logger
    :summary:
    ```
````

### API

````{py:data} logger
:canonical: dawsonia.io._pdf.logger
:value: >
   'getLogger(...)'

```{autodoc2-docstring} dawsonia.io._pdf.logger
```

````

````{py:function} read_pdf_book(path_file: pathlib.Path, first_page: int = 1, last_page: int = 1000000, page_middle: int | None = None, size_cell: list[float] | None = None, table_fmt_dir: pathlib.Path = Path('table_formats')) -> tuple[int, int, dawsonia.io._book.Book]
:canonical: dawsonia.io._pdf.read_pdf_book

```{autodoc2-docstring} dawsonia.io._pdf.read_pdf_book
```
````

````{py:function} log_pdf_metadata(pdf: pdfplumber.PDF) -> None
:canonical: dawsonia.io._pdf.log_pdf_metadata

```{autodoc2-docstring} dawsonia.io._pdf.log_pdf_metadata
```
````

````{py:function} check_pdf_page_range(path_pdf, first_page=1, last_page=1000000)
:canonical: dawsonia.io._pdf.check_pdf_page_range

```{autodoc2-docstring} dawsonia.io._pdf.check_pdf_page_range
```
````

````{py:function} station_name_from_pdf(path_pdf: pathlib.Path) -> str
:canonical: dawsonia.io._pdf.station_name_from_pdf

```{autodoc2-docstring} dawsonia.io._pdf.station_name_from_pdf
```
````

````{py:function} year_from_pdf(path_pdf: pathlib.Path) -> str
:canonical: dawsonia.io._pdf.year_from_pdf

```{autodoc2-docstring} dawsonia.io._pdf.year_from_pdf
```
````

````{py:function} get_pdf_pages(path_pdf: pathlib.Path, left_page: int, right_page: int) -> typing.Iterator[dawsonia.typing.NDArray[numpy.int32]]
:canonical: dawsonia.io._pdf.get_pdf_pages

```{autodoc2-docstring} dawsonia.io._pdf.get_pdf_pages
```
````

````{py:function} set_skip_dict(skip_table: list[int], skip_rows, skip_cols, table_formats) -> dict[str, list]
:canonical: dawsonia.io._pdf.set_skip_dict

```{autodoc2-docstring} dawsonia.io._pdf.set_skip_dict
```
````