Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added docstring to logging.py and added pydocstyle to github workflow #158

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/pydosctyle.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Lint and Test

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest

steps:
- name: Check out code
uses: actions/checkout@v2

- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.8'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pydocstyle

- name: Run pydocstyle
run: |
pydocstyle
2 changes: 2 additions & 0 deletions .pydocstyle
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[pydocstyle]
ignore = D203,D213,D406,D407,D415
18 changes: 18 additions & 0 deletions src/tirith/logging.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
"""
Sets up logging configuration for the application.

It provides a default logging configuration with different handlers and formatters
to control the verbosity and formatting of log messages. The ``setup_logging`` function
allows switching between verbose and normal logging modes.

"""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove the It provides a default logging configuration with different handlers and formatters to control the verbosity and formatting of log messages. The ``setup_logging`` function allows switching between verbose and normal logging modes. part



import logging
import logging.config
import sys
Expand Down Expand Up @@ -38,6 +48,14 @@


def setup_logging(verbose: bool = False):

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove this newline

"""
Set up logging configuration. The default argument verbose: bool = False.

Here, if `verbose` is set to ``True``,then all the log messages higher than DEBUG level will be displayed in `verbose` format.
But, if `verbose` is set to ``False``, all the log messages that are higher than INFO level i.e. ('INFO', 'WARNING', 'CRITICAL') will be dsiplayed in `normal` format.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the detailed docstring! but I think it can be made shorter

I'd write it as the following:

    Set up logging configuration.

    :param verbose:  If set to `True` will log all messages higher than DEBUG level, otherwise it will log the messages that are higher than INFO level ('INFO', 'WARNING', 'CRITICAL')

"""
if verbose:
DEFAULT_LOGGING_CONFIG["root"]["handlers"] = ["console_stderr_verbose"]
logging.config.dictConfig(DEFAULT_LOGGING_CONFIG)
Loading