Skip to content

Commit

Permalink
Nicer naming.
Browse files Browse the repository at this point in the history
  • Loading branch information
@idlesign
idlesign committed Jul 11, 2017
1 parent 84554fe commit a8bd7f7
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 86 deletions.
4 changes: 2 additions & 2 deletions tests/options/test_logging.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ def test_logging_basics(assert_lines):

], logging.set_basic_params(
no_requests=True,
template='%s --> %s' % (logging.Vars.REQ_METHOD, logging.Vars.REQ_URL)
template='%s --> %s' % (logging.vars.REQ_METHOD, logging.vars.REQ_URL)
))

assert_lines([
Expand Down Expand Up @@ -106,5 +106,5 @@ def test_logging_add_logger_encoder(assert_lines):
'log-encoder = format > ${msg} <:myfile',

], logging.add_logger_encoder([
enc_format('> %s <' % enc_format.Vars.MESSAGE),
enc_format('> %s <' % enc_format.vars.MESSAGE),
], logger=logging.cls_logger_file('myfile', '/home/here.log')))
4 changes: 2 additions & 2 deletions tests/options/test_main_process.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ def test_main_process_hooks(assert_lines):
section = Section()

prc = section.main_process
asap = prc.Phases.ASAP
asap = prc.phases.ASAP

prc.set_hook(asap, prc.cls_handler_mount('/proc', 'proc', 'none'))
prc.set_hook(asap, prc.cls_handler_mount('/proc', flags=['rec', 'detach']))
Expand All @@ -56,7 +56,7 @@ def test_main_process_hooks(assert_lines):
prc.set_hook(asap, prc.cls_handler_call('some', honour_exit_status=True))
prc.set_hook(asap, prc.cls_handler_change_dir('/here'))
prc.set_hook(asap, prc.cls_handler_exit())
prc.set_hook(prc.Phases.APP_LOAD_PRE, prc.cls_handler_exit(10))
prc.set_hook(prc.phases.APP_LOAD_PRE, prc.cls_handler_exit(10))
prc.set_hook(asap, prc.cls_handler_print('bingo-bongo'))
prc.set_hook(asap, prc.cls_handler_write('/here/a.txt', 'sometext'))
prc.set_hook(asap, prc.cls_handler_write('/here/b', '10', fifo=True))
Expand Down
72 changes: 36 additions & 36 deletions uwsgiconf/options/logging.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def __str__(self):
return '%s %s' % (self.alias, ''.join(chunks))


class FileLogger(Logger):
class LoggerFile(Logger):
"""Allows logging into files."""

plugin = 'file'
Expand All @@ -33,10 +33,10 @@ def __init__(self, alias, filepath):
:param str|unicode filepath: File path.
"""
super(FileLogger, self).__init__(alias, filepath)
super(LoggerFile, self).__init__(alias, filepath)


class SocketLogger(Logger):
class LoggerSocket(Logger):
"""Allows logging into UNIX and UDP sockets."""

plugin = 'socket'
Expand All @@ -52,10 +52,10 @@ def __init__(self, alias, addr_or_path):
* 192.168.173.19:5050
"""
super(SocketLogger, self).__init__(alias, addr_or_path)
super(LoggerSocket, self).__init__(alias, addr_or_path)


class SyslogLogger(Logger):
class LoggerSyslog(Logger):
"""Allows logging into Unix standard syslog or a remote syslog."""

plugin = 'syslog'
Expand All @@ -79,10 +79,10 @@ def __init__(self, alias, app_name=None, facility=None, host=None):

args.extend([app_name, facility])

super(SyslogLogger, self).__init__(alias, *args)
super(LoggerSyslog, self).__init__(alias, *args)


class RedisLogger(Logger):
class LoggerRedis(Logger):
"""Allows logging into Redis.
.. note:: Consider using ``dedicate_thread`` param.
Expand All @@ -106,10 +106,10 @@ def __init__(self, alias, host=None, command=None, prefix=None):
:param str|unicode prefix: Default: <empty>
"""
super(RedisLogger, self).__init__(alias, host, command, prefix)
super(LoggerRedis, self).__init__(alias, host, command, prefix)


class MongoLogger(Logger):
class LoggerMongo(Logger):
"""Allows logging into Mongo DB.
.. note:: Consider using ``dedicate_thread`` param.
Expand All @@ -130,10 +130,10 @@ def __init__(self, alias, host=None, collection=None, node=None):
sending logs Default: <server hostname>
"""
super(MongoLogger, self).__init__(alias, host, collection, node)
super(LoggerMongo, self).__init__(alias, host, collection, node)


class ZeroMqLogger(Logger):
class LoggerZeroMq(Logger):
"""Allows logging into ZeroMQ sockets."""

plugin = 'zeromq'
Expand All @@ -148,7 +148,7 @@ def __init__(self, alias, connection_str):
* tcp://192.168.173.18:9191
"""
super(ZeroMqLogger, self).__init__(alias, connection_str)
super(LoggerZeroMq, self).__init__(alias, connection_str)


class Encoder(object):
Expand All @@ -162,7 +162,7 @@ def __str__(self):
return '%s %s' % (self.name, self.args[0])


class PrefixEncoder(Encoder):
class EncoderPrefix(Encoder):
"""Add a raw prefix to each log msg."""

name = 'prefix'
Expand All @@ -173,34 +173,34 @@ def __init__(self, value):
:param str|unicode value: Value to be used as affix
"""
super(PrefixEncoder, self).__init__(value)
super(EncoderPrefix, self).__init__(value)


class SuffixEncoder(PrefixEncoder):
class EncoderSuffix(EncoderPrefix):
"""Add a raw suffix to each log msg"""

name = 'suffix'


class NewlineEncoder(Encoder):
class EncoderNewline(Encoder):
"""Add a newline char to each log msg."""

name = 'nl'


class GzipEncoder(Encoder):
class EncoderGzip(Encoder):
"""Compress each msg with gzip (requires zlib)."""

name = 'gzip'


class CompressEncoder(Encoder):
class EncoderCompress(Encoder):
"""Compress each msg with zlib compress (requires zlib)."""

name = 'compress'


class FormatEncoder(Encoder):
class EncoderFormat(Encoder):
"""Apply the specified format to each log msg."""

name = 'format'
Expand All @@ -212,9 +212,9 @@ def __init__(self, template):
Available variables are listed in ``FormatEncoder.Vars``.
"""
super(FormatEncoder, self).__init__(template)
super(EncoderFormat, self).__init__(template)

class Vars(object):
class vars(object):
"""Variables available to use."""

MESSAGE = '${msg}'
Expand All @@ -232,7 +232,7 @@ class Vars(object):
# todo consider adding ${strftime:xxx} - strftime using the xxx format


class JsonEncoder(FormatEncoder):
class EncoderJson(EncoderFormat):
"""Apply the specified format to each log msg with each variable json escaped."""

name = 'json'
Expand All @@ -246,21 +246,21 @@ class Logging(OptionsGroup):
"""

cls_logger_file = FileLogger
cls_logger_socket = SocketLogger
cls_logger_syslog = SyslogLogger
cls_logger_redis = RedisLogger
cls_logger_mongo = MongoLogger
cls_logger_zeromq = ZeroMqLogger
cls_logger_file = LoggerFile
cls_logger_socket = LoggerSocket
cls_logger_syslog = LoggerSyslog
cls_logger_redis = LoggerRedis
cls_logger_mongo = LoggerMongo
cls_logger_zeromq = LoggerZeroMq
# todo consider adding other loggers: crypto, graylog2, systemd

cls_encoder_prefix = PrefixEncoder
cls_encoder_suffix = SuffixEncoder
cls_encoder_newline = NewlineEncoder
cls_encoder_gzip = GzipEncoder
cls_encoder_compress = CompressEncoder
cls_encoder_format = FormatEncoder
cls_encoder_json = JsonEncoder
cls_encoder_prefix = EncoderPrefix
cls_encoder_suffix = EncoderSuffix
cls_encoder_newline = EncoderNewline
cls_encoder_gzip = EncoderGzip
cls_encoder_compress = EncoderCompress
cls_encoder_format = EncoderFormat
cls_encoder_json = EncoderJson
# todo consider adding msgpack encoder

def set_basic_params(
Expand Down Expand Up @@ -496,7 +496,7 @@ def add_logger_encoder(self, encoder, logger=None, requests_only=False, for_sing

return self._section

class Vars(object):
class vars(object):
"""Variables available for custom log formatting."""

# The following are taken blindly from the internal wsgi_request structure of the current request.
Expand Down
52 changes: 26 additions & 26 deletions uwsgiconf/options/main_process.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def __str__(self):
return result.strip()


class MountHandler(Handler):
class HandlerMount(Handler):
"""Mount or unmount filesystems.
Examples:
Expand Down Expand Up @@ -50,10 +50,10 @@ def __init__(self, mountpoint, fs=None, src=None, flags=None):
args = [mountpoint, flags]
self.name = 'umount'

super(MountHandler, self).__init__(*args)
super(HandlerMount, self).__init__(*args)


class ExecHandler(Handler):
class HandlerExec(Handler):
"""Run the shell command.
Command run under ``/bin/sh``.
Expand All @@ -68,10 +68,10 @@ class ExecHandler(Handler):
name = 'exec'

def __init__(self, command):
super(ExecHandler, self).__init__(command)
super(HandlerExec, self).__init__(command)


class CallHandler(Handler):
class HandlerCall(Handler):
"""Call functions in the current process address space."""

name = 'call'
Expand All @@ -96,10 +96,10 @@ def __init__(self, target, honour_exit_status=False, arg_int=False):

self.name = name

super(CallHandler, self).__init__(target)
super(HandlerCall, self).__init__(target)


class ChangeDirHandler(Handler):
class HandlerChangeDir(Handler):
"""Changes a directory.
Convenience handler, same as ``call:chdir <directory>``.
Expand All @@ -108,10 +108,10 @@ class ChangeDirHandler(Handler):
name = 'cd'

def __init__(self, target_dir):
super(ChangeDirHandler, self).__init__(target_dir)
super(HandlerChangeDir, self).__init__(target_dir)


class ExitHandler(Handler):
class HandlerExit(Handler):
"""Exits.
Convenience handler, same as ``callint:exit [num]``.
Expand All @@ -120,10 +120,10 @@ class ExitHandler(Handler):
name = 'exit'

def __init__(self, status_code=None):
super(ExitHandler, self).__init__(status_code)
super(HandlerExit, self).__init__(status_code)


class PrintHandler(Handler):
class HandlerPrint(Handler):
"""Prints.
Convenience handler, same as calling the ``uwsgi_log`` symbol.
Expand All @@ -132,10 +132,10 @@ class PrintHandler(Handler):
name = 'print'

def __init__(self, text=None):
super(PrintHandler, self).__init__(text)
super(HandlerPrint, self).__init__(text)


class WriteHandler(Handler):
class HandlerWrite(Handler):
"""Writes a string to the specified file/fifo.
.. note:: Since 1.9.21
Expand All @@ -156,10 +156,10 @@ def __init__(self, target, text, fifo=False):
if fifo:
self.name += 'fifo'

super(WriteHandler, self).__init__(target, text)
super(HandlerWrite, self).__init__(target, text)


class UnlinkHandler(Handler):
class HandlerUnlink(Handler):
"""Unlink the specified file.
.. note:: Since 1.9.21
Expand All @@ -168,22 +168,22 @@ class UnlinkHandler(Handler):
name = 'unlink'

def __init__(self, target):
super(UnlinkHandler, self).__init__(target)
super(HandlerUnlink, self).__init__(target)


class MainProcess(OptionsGroup):
"""Main process is the uWSGi process."""

cls_handler_mount = MountHandler
cls_handler_exec = ExecHandler
cls_handler_call = CallHandler
cls_handler_change_dir = ChangeDirHandler
cls_handler_exit = ExitHandler
cls_handler_print = PrintHandler
cls_handler_write = WriteHandler
cls_handler_unlink = UnlinkHandler
cls_handler_mount = HandlerMount
cls_handler_exec = HandlerExec
cls_handler_call = HandlerCall
cls_handler_change_dir = HandlerChangeDir
cls_handler_exit = HandlerExit
cls_handler_print = HandlerPrint
cls_handler_write = HandlerWrite
cls_handler_unlink = HandlerUnlink

class Phases:
class phases:
"""Phases available for hooking.
Some of them may be **fatal** - a failing hook for them
Expand Down Expand Up @@ -410,7 +410,7 @@ def set_hook(self, phase, handler):

return self._section

def run_command_on_event(self, command, phase=Phases.ASAP):
def run_command_on_event(self, command, phase=phases.ASAP):
"""Run the given command on a given phase.
:param str|unicode command:
Expand Down

0 comments on commit a8bd7f7

Please sign in to comment.