mirror of
https://github.com/rzmk/czv.git
synced 2025-12-19 08:09:24 +00:00
ce260e9491
- Add `file_path` for czv-python count operations - Refactor tests based on file path instead of data - Use thiserror in czv - Update examples to reflect changes
44 lines
954 B
Python
44 lines
954 B
Python
"""
|
|
# czv
|
|
|
|
Python library for [czv](https://github.com/rzmk/czv). CSV content manipulation and analysis.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
pip install czv
|
|
```
|
|
|
|
## Example
|
|
|
|
```python
|
|
from czv import row_count
|
|
|
|
output = row_count(file_path="fruits.csv")
|
|
|
|
print(output)
|
|
```
|
|
|
|
"""
|
|
|
|
from typing import Optional
|
|
from pathlib import Path
|
|
|
|
def row_count(file_path: Optional[Path], file_data: Optional[str], include_header_row: Optional[bool]) -> int:
|
|
"""Returns a count of the total number of rows.
|
|
|
|
## Arguments
|
|
|
|
* `file_path` - CSV file path.
|
|
* `file_data` - CSV file data.
|
|
* `include_header_row` - Specify whether to include the header row (first row) in the row count. Default is false.
|
|
"""
|
|
|
|
def column_count(file_path: Optional[Path], file_data: Optional[str]) -> int:
|
|
"""Returns a count of the total number of columns (fields).
|
|
|
|
## Arguments
|
|
|
|
* `file_path` - CSV file path.
|
|
* `file_data` - CSV file data.
|
|
"""
|