Enhance configuration options #385
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added examples for configuring processing limits in README.md. - Introduced new CLI options for max files, max total size, and max directory depth. - Updated environment variable support in config.py for various limits. - Modified ingestion functions to accept new parameters for file processing limits. - Enhanced limit checks in ingestion logic to utilize new configuration options.
Refactor * Deduplicate `_get_env_var` by moving it to `utils/config_utils.py`. * Remove redundant `local_path` parameter from `_process_file`. Fix * Add missing `tag` parameter to `_async_main`, `main`, and `_CLIArgs`. * Introduce the missing `--tag` CLI flag. Docs and consistency * Update `README.md` for `markdownlint` compliance and other minor tweaks. * Add missing argument docs to `_async_main` docstring. * Re-order global variables in `config.py` for consistency. * Swap the order of `include_patterns` and `ignore_patterns` in `parse_query` and `ingest_async`. * Tidy docstrings for `_async_main`, `IngestionQuery`, `parse_query`, `ingest_async`, and `ingest`. Tests * Temporarily disable `[tool.ruff.lint.isort]` due to conflict with the `isort` pre-commit hook. * Add new arguments to `expected` in `test_parse_query_without_host`. * Run `pre-commit` hooks.
|
Thanks for your work @Cheelax. I have rebase upon Refactor
Fix
Docs and consistency
Tests
TODO
|
src/gitingest/utils/config_utils.py
Outdated
Comment on lines
9
to
40
| def _get_env_var(key: str, default: int | str, cast_func: Callable[[str], int | str] | None = None) -> int | str: | ||
| """Get environment variable with ``GITINGEST_`` prefix and optional type casting. | ||
|
|
||
| Parameters | ||
| ---------- | ||
| key : str | ||
| The name of the environment variable. | ||
| default : int | str | ||
| The default value to return if the environment variable is not set. | ||
| cast_func : Callable[[str], int | str] | None | ||
| The function to cast the environment variable to the desired type. | ||
|
|
||
| Returns | ||
| ------- | ||
| int | str | ||
| The value of the environment variable, cast to the desired type if provided. | ||
|
|
||
| """ | ||
| env_key = f"GITINGEST_{key}" | ||
| value = os.environ.get(env_key) | ||
|
|
||
| if value is None: | ||
| return default | ||
|
|
||
| if cast_func: | ||
| try: | ||
| return cast_func(value) | ||
| except (ValueError, TypeError): | ||
| print(f"Warning: Invalid value for {env_key}: {value}. Using default: {default}") | ||
| return default | ||
|
|
||
| return value |
There was a problem hiding this comment.
I like the approach but I think in the end having int | str as a return type might cause some unnecessary headaches in some situations.
Perhaps just returning str and casting whenever calling the function is fine?
|
@filipchristiansen it looks to me that the naming is good in the readme. Every var I am looking for should be prefixed by : |
- Introduced a new helper function `_get_int_env_var` to retrieve environment variables as integers with default fallback and error handling. - Updated `config.py` and `server_config.py` to use the new helper function for better clarity and maintainability. - Simplified `_get_env_var` in `config_utils.py` to focus solely on retrieving string values without type casting.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #285