如何优雅地构建python包结构与执行python脚本

本文主要总结楼主在平常python代码构建中遇到的python包结构无法找到的一些问题,最近看了一些相关文档,将其中一些琐碎知识汇总而成。

万恶之源

你是否对ImportError: No module named 'local'感到无比的熟悉?

Demo Project

一个简单python项目的文件结构示例
这是简单python项目的文件结构示例
foo/main.py

import sys

if __name__ == "__main__":
    print(sys.path)

我们在foo目录下运行main.py ,结果如下:
这里写图片描述
此时我们想到导入同目录下的foo.py文件,其文件内容仅为s = "hello world"
在main.py中加入from foo import foo1,结果出现了大家熟悉的ImportError: No module named 'foo'

这个importError由两部分引起:

  1. foo并不被被python视为一个package模块
  2. foo包的位置不被python所知

solution


    • 在foo目录下添加_init_.py文件

    • 通过添加sys.path
    • 通过添加PYTHONPATH
    • 通过python -m 运行包

首先solution 1没有什么疑问,如果有疑问可以参考此处1
对于solution 2前两种方法的缺点:
- PYTHONPATH每次登陆服务器之后都要export,十分麻烦,而且一旦很多package出现PYTHONPATH会变的十分臃肿
- sys.path如果采用相对路径添加则对入口函数十分依赖,如果采用绝对路径则代码迁移可能出现问题

以上针对同目录做了一些介绍,以下对不同目录导入文件做一些补充:
在foo/main.py中导入bar1.py文件

from src.bar import bar1

或者 (子包导入也可以采用如下做法)

from src.bar.bar1 import *

最终目录结构(每一个python文件目录都需要添加init.py)
这里写图片描述

python -m src.foo.main # src上层目录运行
import src.bar.bar1 import * # foo/main.py

结果如下:
这里写图片描述

发布了15 篇原创文章 · 获赞 7 · 访问量 1万+
展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 大白 设计师: CSDN官方博客

分享到微信朋友圈

×

扫一扫,手机浏览