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

Fixes logging by removing root logger and handlers from library #19

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
162 changes: 162 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,162 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
.pdm.toml
.pdm-python
.pdm-build/

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
6 changes: 4 additions & 2 deletions requests_throttler/example.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

from requests_throttler import BaseThrottler

import logging


def parse_args():
parser = argparse.ArgumentParser()
Expand Down Expand Up @@ -32,9 +34,9 @@ def main():
throttled_requests = bt.multi_submit(reqs)

for r in throttled_requests:
print r.response
print(r.response)

print "Success: {s}, Failures: {f}".format(s=bt.successes, f=bt.failures)
print("Success: {s}, Failures: {f}".format(s=bt.successes, f=bt.failures))


if __name__ == '__main__':
Expand Down
18 changes: 7 additions & 11 deletions requests_throttler/settings.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
import logging

###----------------------###
#---- Logging settings ----#
###----------------------###
LOG_FORMAT_0=("[TID=%(thread)d - Thread=%(threadName)s - %(asctime)s - %(levelname)s - "
"%(module)s.%(funcName)s(%(lineno)d)]: %(message)s")
LOG_FORMAT_1=("[Thread=%(threadName)s - %(asctime)s - %(levelname)s]: %(message)s")
LOG_FORMAT_2=("[%(asctime)s - %(levelname)s]: %(message)s")
LOG_FORMAT={logging.DEBUG: LOG_FORMAT_0,
logging.INFO: LOG_FORMAT_1,
logging.WARNING: LOG_FORMAT_2,
logging.ERROR: LOG_FORMAT_0,
logging.CRITICAL: LOG_FORMAT_0}
DEFAULT_LOG_LEVEL=logging.INFO

# Removed logging settings as this will be handled by the root logger
#
# Logging is provided throughout the request throttling process and is sent to the root logger in the application that calls this library.
# Instantiate a logger object using logger = logging.getLogger() - note that no argument is provided for a root logger.
# This will act as the parent logger for this library's own logger and will control all logging output/formatting
# The root logger will need to be configured with file and/or stream handlers as per: https://docs.python.org/3/howto/logging.html#logging-advanced-tutorial
5 changes: 3 additions & 2 deletions requests_throttler/throttler.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

"""

import logging
import time
import threading
from collections import deque as queue
Expand All @@ -16,10 +17,10 @@
import requests

from requests_throttler.utils import Timer
from requests_throttler.utils import locked, get_logger
from requests_throttler.utils import locked
from requests_throttler.throttled_request import ThrottledRequest

logger = get_logger(__name__)
logger = logging.getLogger(__name__)

THROTTLER_STATUS = ['initialized', 'running', 'waiting', 'paused', 'stopped', 'ending', 'ended']
THROTTLER_STATUS_DEPENDENCIES = {'initialized': ['initialized', 'running', 'stopped'],
Expand Down
12 changes: 0 additions & 12 deletions requests_throttler/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,9 @@
"""

import time
import logging
import threading
from functools import wraps

from requests_throttler.settings import \
LOG_FORMAT, \
DEFAULT_LOG_LEVEL


def locked(lock):
"""Decorator usefull to access to a function with a lock named *lock*
Expand All @@ -41,13 +36,6 @@ def wrapper(*args, **kwargs):
return _locked


def get_logger(name, level=DEFAULT_LOG_LEVEL):
logging.basicConfig(format=LOG_FORMAT[level])
logger = logging.getLogger(name)
logger.setLevel(level)
return logger


class NoCheckpointSetError(Exception):
"""Exception that occurs when no checkpoint is set and it is needed

Expand Down