.. module:: Files


Files
=========================

Utilities for CSV file handling and data transformations.


Quick Examples
--------------------------

Reading CSV Files
~~~~~~~~~~~~~~~~~

.. code-block:: python

    from core_mixins.files import records_from_csv

    # Read CSV file
    for record in records_from_csv("data.csv"):
        print(record)  # Each record is a dictionary


Writing CSV Files
~~~~~~~~~~~~~~~~~

.. code-block:: python

    from core_mixins.files import records_to_csv

    records = [
        {"name": "Alice", "age": 30, "city": "NYC"},
        {"name": "Bob", "age": 25, "city": "LA"},
    ]

    # Write to CSV file
    records_to_csv(
        file_path="output.csv",
        records=records,
        columns=["name", "age", "city"],
        with_headers=True
    )


In-Memory CSV Operations
~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: python

    from core_mixins.files import records_to_buffer, records_from_buffer

    records = [
        {"name": "Alice", "age": 30},
        {"name": "Bob", "age": 25},
    ]

    # Create CSV in memory
    buffer = records_to_buffer(records, columns=["name", "age"])

    # Read from buffer
    csv_string = buffer.getvalue()
    for record in records_from_buffer(csv_string):
        print(record)


API Reference
--------------------------

.. automodule:: core_mixins.files.utils
   :members:
   :undoc-members:
   :show-inheritance: