# {py:mod}`nexusLIMS.builder.record_builder`

```{py:module} nexusLIMS.builder.record_builder
```

```{autodoc2-docstring} nexusLIMS.builder.record_builder
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`RecordBuildResult <nexusLIMS.builder.record_builder.RecordBuildResult>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.RecordBuildResult
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

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

* - {py:obj}`build_record <nexusLIMS.builder.record_builder.build_record>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_record
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_reservation_event <nexusLIMS.builder.record_builder.get_reservation_event>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.get_reservation_event
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`build_acq_activities <nexusLIMS.builder.record_builder.build_acq_activities>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_acq_activities
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_files <nexusLIMS.builder.record_builder.get_files>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.get_files
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`dump_record <nexusLIMS.builder.record_builder.dump_record>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.dump_record
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`validate_record <nexusLIMS.builder.record_builder.validate_record>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.validate_record
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`build_new_session_records <nexusLIMS.builder.record_builder.build_new_session_records>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_new_session_records
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`process_new_records <nexusLIMS.builder.record_builder.process_new_records>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.process_new_records
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`dry_run_file_find <nexusLIMS.builder.record_builder.dry_run_file_find>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.dry_run_file_find
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Data

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

* - {py:obj}`XSD_PATH <nexusLIMS.builder.record_builder.XSD_PATH>`
  - ```{autodoc2-docstring} nexusLIMS.builder.record_builder.XSD_PATH
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:data} XSD_PATH
:canonical: nexusLIMS.builder.record_builder.XSD_PATH

**Type:** pathlib.Path

```{autodoc2-docstring} nexusLIMS.builder.record_builder.XSD_PATH
:parser: autodoc2_docstrings_parser
```

````

`````{py:class} RecordBuildResult
:canonical: nexusLIMS.builder.record_builder.RecordBuildResult

```{autodoc2-docstring} nexusLIMS.builder.record_builder.RecordBuildResult
:parser: autodoc2_docstrings_parser
```

````{py:attribute} xml_text
:canonical: nexusLIMS.builder.record_builder.RecordBuildResult.xml_text

**Type:** str

```{autodoc2-docstring} nexusLIMS.builder.record_builder.RecordBuildResult.xml_text
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} activities
:canonical: nexusLIMS.builder.record_builder.RecordBuildResult.activities
:value: >
   'field(...)'

**Type:** typing.List[nexusLIMS.schemas.activity.AcquisitionActivity]

```{autodoc2-docstring} nexusLIMS.builder.record_builder.RecordBuildResult.activities
:parser: autodoc2_docstrings_parser
```

````

````{py:attribute} reservation_event
:canonical: nexusLIMS.builder.record_builder.RecordBuildResult.reservation_event

**Type:** nexusLIMS.harvesters.reservation_event.ReservationEvent | None

```{autodoc2-docstring} nexusLIMS.builder.record_builder.RecordBuildResult.reservation_event
:parser: autodoc2_docstrings_parser
```

````

`````

````{py:function} build_record(session: nexusLIMS.db.session_handler.Session, sample_id: str | None = None, *, generate_previews: bool = True) -> nexusLIMS.builder.record_builder.RecordBuildResult
:canonical: nexusLIMS.builder.record_builder.build_record

```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_record
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_reservation_event(session: nexusLIMS.db.session_handler.Session) -> nexusLIMS.harvesters.reservation_event.ReservationEvent
:canonical: nexusLIMS.builder.record_builder.get_reservation_event

```{autodoc2-docstring} nexusLIMS.builder.record_builder.get_reservation_event
:parser: autodoc2_docstrings_parser
```
````

````{py:function} build_acq_activities(instrument, dt_from, dt_to, generate_previews)
:canonical: nexusLIMS.builder.record_builder.build_acq_activities

```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_acq_activities
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_files(path: pathlib.Path, dt_from: datetime.datetime, dt_to: datetime.datetime) -> typing.List[pathlib.Path]
:canonical: nexusLIMS.builder.record_builder.get_files

```{autodoc2-docstring} nexusLIMS.builder.record_builder.get_files
:parser: autodoc2_docstrings_parser
```
````

````{py:function} dump_record(session: nexusLIMS.db.session_handler.Session, filename: pathlib.Path | None = None, *, generate_previews: bool = True) -> pathlib.Path
:canonical: nexusLIMS.builder.record_builder.dump_record

```{autodoc2-docstring} nexusLIMS.builder.record_builder.dump_record
:parser: autodoc2_docstrings_parser
```
````

````{py:function} validate_record(xml_filename)
:canonical: nexusLIMS.builder.record_builder.validate_record

```{autodoc2-docstring} nexusLIMS.builder.record_builder.validate_record
:parser: autodoc2_docstrings_parser
```
````

````{py:function} build_new_session_records(generate_previews: bool = True) -> tuple[typing.List[pathlib.Path], typing.List[nexusLIMS.db.session_handler.Session], typing.List[typing.List[nexusLIMS.schemas.activity.AcquisitionActivity]], typing.List[nexusLIMS.harvesters.reservation_event.ReservationEvent | None]]
:canonical: nexusLIMS.builder.record_builder.build_new_session_records

```{autodoc2-docstring} nexusLIMS.builder.record_builder.build_new_session_records
:parser: autodoc2_docstrings_parser
```
````

````{py:function} process_new_records(*, dry_run: bool = False, dt_from: datetime.datetime | None = None, dt_to: datetime.datetime | None = None)
:canonical: nexusLIMS.builder.record_builder.process_new_records

```{autodoc2-docstring} nexusLIMS.builder.record_builder.process_new_records
:parser: autodoc2_docstrings_parser
```
````

````{py:function} dry_run_file_find(s: nexusLIMS.db.session_handler.Session) -> typing.List[pathlib.Path]
:canonical: nexusLIMS.builder.record_builder.dry_run_file_find

```{autodoc2-docstring} nexusLIMS.builder.record_builder.dry_run_file_find
:parser: autodoc2_docstrings_parser
```
````