Python 自定义模块路径

问题:

假设我们自己写了一个名为 log_config.py 的日志记录程序模块。此模块会被其他程序所引用,如下例子。

import log_config
logger = log_config.log_config("./test_log.txt", "tester")
logger.info("log start.")
logger.info("something happens")
logger.info("log end.")

解决方法:

  • 先看一下目前系统中的Python 路径情况:
Python 2.7.6 (default, Jun 22 2015, 17:58:13) 
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> print sys.path
['', '/usr/lib/python2.7', '/usr/lib/python2.7/plat-x86_64-linux-gnu', '/usr/lib/python2.7/lib-tk', '/usr/lib/python2.7/lib-old', '/usr/lib/python2.7/lib-dynload', '/usr/local/lib/python2.7/dist-packages', '/usr/lib/python2.7/dist-packages']
  • 结果显示,在这几个目录都是 Python 的系统目录。我们的模块可以放在如下二个目录即可。
'/usr/local/lib/python2.7/dist-packages', 
'/usr/lib/python2.7/dist-packages'

更进一步:

  • 如果自定义的模块不想与Python 系统的模块放在同一目录下,可以在上面二个目录中增加一个路径文件 user_defined_modules.pth 。此文件内容就是我们自定义模块的存放路径。例子如下:
/home/tom/python_modules/

在 /home/tom/python_module/ 目录中把我们的模块文件 log_config.py 存放好即可。

附录 log_config.py 源码:

此代码可以设置日志文件的生成规则,目录设置的是 1 小时 1 个文件。如果一小时内单个文件大小超过 10 MB会自动分割成多个文件。

#!/usr/bin/python
# encoding=utf-8

#example
#import log_config
#logger = log_config.log_config("./test_log.txt", "tester")
#logger.info("log start")
#logger.info("log end")

#!/usr/bin/env python
# -*- coding:utf-8 -*

""" Setup a Logger which creates a new log file when it
reach up to it limits, such as one hour and file size 10 MB.
"""

__author__ = "Zhiwei Yan"
__copyright__ = "Copyright 2016, The Common tools Project"
__credits__ = ["Zhiwei Yan"]
__license__ = "Apache License"
__version__ = "2.0"
__maintainer__ = "Zhiwei YAN"
__email__ = "jerod.yan@gmail.com"
__status__ = "Production"

import logging
import logging.handlers as handlers
import time, datetime
class SizedTimedRotatingFileHandler(handlers.TimedRotatingFileHandler):
    """
    Handler for logging to a set of files, which switches from one file
    to the next when the current file reaches a certain size, or at certain
    timed intervals
    """
    def __init__(self, filename, mode='a', maxBytes=0, backupCount=0, encoding=None,
                 delay=0, when='h', interval=1, utc=False):
        # If rotation/rollover is wanted, it doesn't make sense to use another
        # mode. If for example 'w' were specified, then if there were multiple
        # runs of the calling application, the logs from previous runs would be
        # lost if the 'w' is respected, because the log file would be truncated
        # on each run.
        if maxBytes > 0:
            mode = 'a'
        handlers.TimedRotatingFileHandler.__init__(
            self, filename, when, interval, backupCount, encoding, delay, utc)
        self.maxBytes = maxBytes

    def shouldRollover(self, record):
        """
        Determine if rollover should occur.

        Basically, see if the supplied record would cause the file to exceed
        the size limit we have.
        """
        if self.stream is None:                 # delay was set...
            self.stream = self._open()
        if self.maxBytes > 0:                   # are we rolling over?
            msg = "%s\n" % self.format(record)
            self.stream.seek(0, 2)  #due to non-posix-compliant Windows feature
            if self.stream.tell() + len(msg) >= self.maxBytes:
                return 1
        t = int(time.time())
        if t >= self.rolloverAt:
            return 1
        return 0



def log_config(log_filename, logger_str):
    
    logging.basicConfig(format = "%(asctime)s" "[%(module)s:%(funcName)s:%(lineno)d]\n" "%(message)s \n")

    logger=logging.getLogger(logger_str)
    logger.propagate = False
    logger.setLevel(logging.DEBUG)

    handler=SizedTimedRotatingFileHandler(
            log_filename, 
            maxBytes=10*1024*1024, backupCount=24*30,
            when='h',interval=1,
            # encoding='bz2',  # uncomment for bz2 compression
            )

    logformatter = logging.Formatter("%(asctime)s" "[%(module)s:%(funcName)s:%(lineno)d]\n" "%(message)s \n")
    handler.setFormatter(logformatter)
    logger.addHandler(handler)

    return logger

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,340评论 5 467
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 83,762评论 2 376
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,329评论 0 329
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,678评论 1 270
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,583评论 5 359
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 47,995评论 1 275
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,493评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,145评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,293评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,250评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,267评论 1 328
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,973评论 3 316
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,556评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,648评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,873评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,257评论 2 345
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,809评论 2 339

推荐阅读更多精彩内容

  • 0.1本系列教程说明 本系列教程,采用的大纲母本为《Understanding Network Hacks Att...
    小黑y99阅读 65,166评论 0 3
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,426评论 6 428
  • 按照官方的解释,加-m选项是以模块的方式执行,那么到底是什么意思呢? 首先我们来看下这段简单的测试代码: #!/u...
    crazyhank阅读 4,363评论 0 0
  • 你觉得“幸运”的时候,是因为你的欲望得到满足;你觉得“不幸”的时候,是因为你的欲望落空。好运气发生在你身上,你当然...
    Satada阅读 127评论 0 0
  • 一朵微尘附着的云,本是纯澈 白天里,你就在山川大海上漂泊 你是自由的 偶然倾心,宿命在作怪 我知道,你必然不会爱我...
    大圣归去来兮阅读 223评论 0 3