文档内容学习于

http://www.cnblogs.com/xiaozhiqi/

参考:

https://www.cnblogs.com/monologuesmw/p/9490093.html

软件目录结构规范

  1. 可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解、跟进这个项目。
  2. 可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱,仍然能够组织良好。
Foo/
|-- bin/
| |-- foo
|
|-- foo/
| |-- tests/
| | |-- __init__.py
| | |-- test_main.py
| |
| |-- __init__.py
| |-- main.py
|
|-- docs/
| |-- conf.py
| |-- abc.rst
|
|-- setup.py
|-- requirements.txt
|-- README

简要解释一下:

  1. bin/: 存放项目的一些可执行文件,当然你可以起名script/之类的也行。
  2. foo/: 存放项目的所有源代码。(1) 源代码中的所有模块、包都应该放在此目录。不要置于顶层目录。(2) 其子目录tests/存放单元测试代码; (3) 程序的入口最好命名为main.py
  3. docs/: 存放一些文档,配置文件等。
  4. setup.py: 安装、部署、打包的脚本。
  5. requirements.txt: 存放软件依赖的外部Python包列表,这只是一个txt文件。
  6. README: 项目说明文件。

关于配置文件:

此处配置文件conf.py并未直接放于源码目录下,而是放置在docs/目录下,模块的配置应该是灵活的,不受外界配置文件的影响,所以不应当在代码中直接import conf 来使用配置文件,可以通过给main.py启动参数指定配置路径的方式来让程序读取配置内容。

关于setup.py

一般来说,用setup.py来管理代码的打包、安装、部署问题。业界标准的写法是用Python流行的打包工具setuptools来管理这些事情。这种方式普遍应用于开源项目中。不过这里的核心思想不是用标准化的工具来解决这些问题,而是说,一个项目一定要有一个安装部署工具,能快速便捷的在一台新机器上将环境装好、代码部署好和将程序运行起来。

整合打包时应核对requirements中所记录的python包列表与实际使用的Python包是否吻合,包括使用包的版本

关于requirements.txt

这个文件存在的目的是:

    1. 方便开发者维护软件的包依赖。将开发过程中新增的包添加进这个列表中,避免在setup.py安装依赖时漏掉软件包。
    2. 方便读者明确项目使用了哪些Python包,通过包的学习快速跟进项目程序。

  requirements.txt中存放软件依赖的外部Python包列表最好和开发过程中软件实际使用的Python包保持实时同步,这样在最后打包setup.py文件时才不会有遗漏。

关于ReadMe

这个同setup.py一样,是每个项目都应该有的一个文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。

它需要说明以下几个事项:

    1. 软件定位,软件的基本功能。
    2. 运行代码的方法: 安装环境、启动命令等。
    3. 简要的使用说明。
    4. 代码目录结构说明,更详细点可以说明软件的基本原理。
    5. 常见问题说明。

ReadMe的作用就好像是干练的用户使用手册说明,这样的文档多在项目完结的时候进行撰写。

跨目录读取程序文件

在python中,如果要调用其他的脚本。 需要进行import。 但是如果程序在其他目录线面,直接 import 会报错的

以下是调取程序的 方法

我们现在有这么一个目录

可以使用os.path

import  os

print (os.path.abspath(__file__))                                      # 打印文件路径
print (os.path.dirname( os.path.abspath(__file__) )) # 打印目录的路劲

执行结果

然后调取程序的话  看以下

[root@master Atm]# pwd                                                #全路径
/root/python/day4/Atm
[root@master Atm]# tree #目录结构,里面有3个py程序
.
├── bin
│ └── atm.py # 主文件
├── conf
│ ├── __pycache__
│ │ └── setting.cpython-36.pyc
│ └── setting.py #被调取程序1
└── foo
├── main.py #被调取程序2
└── __pycache__
└── main.cpython-36.pyc 5 directories, 5 files [root@master Atm]# cat bin/atm.py #主程序,执行的程序。 里面的程序下面会详细解释 ,先知道有这么一个文件。
#!/usr/bin/env python3 import os
import sys
print (os.path.abspath(__file__))
print (os.path.dirname( os.path.abspath(__file__) )) BASE_DIR= os.path.dirname(os.path.dirname( os.path.abspath(__file__) ))
sys.path.append( BASE_DIR ) from conf import setting
from foo import main main
main.login() [root@master Atm]# cat conf/setting.py #被调取程序1
#!/usr/bin/env python3
print ("welcome") [root@master Atm]# cat foo/main.py #被调取程序2,里面是个函数
#!/usr/bin/env python3 def login():
print ("please login")

执行主程序。调取另外2个程序

[root@master Atm]# ls
bin conf foo
[root@master Atm]# cat ./bin/atm.py
#!/usr/bin/env python3 import os
import sys
print (os.path.abspath(__file__)) #打印文件路劲
print (os.path.dirname( os.path.abspath(__file__) )) #打印文件的目录路劲,这个时候是在bin这一层。
print (os.path.dirname(os.path.dirname( os.path.abspath(__file__) ))) #打印文件的目录路劲, 这个时候是在atm这一层。就是os.path.dirname这个再用了一次 BASE_DIR= os.path.dirname(os.path.dirname( os.path.abspath(__file__) )) # 要调取其他目录下的文件。 需要在atm这一层才可以
sys.path.append( BASE_DIR ) # 将这个路径添加到环境变量中。 from conf import setting # 根据目录调取程序(文件)
from foo import main # 根据目录调取程序(文件) setting #直接执行程序

main.login() #执行程序中的函数 [root@master Atm]# ./bin/atm.py # 看执行结果
/root/python/day4/Atm/bin/atm.py
/root/python/day4/Atm/bin
/root/python/day4/Atm
welcome #执行了setting的程序

please  login #执行了main的程序

这样就搞定了,跨目录调取文件 。

注意:

在pycharm中如果发现 调取其他程序中的模块,有红线时,如果确定自己的语法没问题,并且模块确实存在且能调到。忽略它。不影响执行。(如果执行报错,就是代码有问题)。

因为pycharm是动态加载的。 可能是因为 pycharm本生就没有这2个模块的 。所以报红线。  但是左侧的目录树里面 ,是正常的。 不影响执行。

python 一些程序规范(跨目录调用文件)的更多相关文章

  1. pycharm跨目录调用文件

    笔者今天在一个测试qq群中遇到解决跨目录中调用文件的问题.现在来详细说一下. 以下图目录为例: 1.同目录下直接调用掉用.test2.py和test3.py在同一个目录test2下. 所以在test3 ...

  2. 【python跨目录调用】结合自己遇到的问题到解决问题,作个记录

    写PO的时候,想把page和case 文件分开存不同的文件夹,但是在调用模块的时候就出现了问题.后来终于解决了,记录下 ---------------------------------------- ...

  3. php中cookie技术关于跨目录调用cookie值的问题

    今天做项目发现了一个奇葩错误,以cookie技术为主,反复测试发现cookie不能跨目录调用. 我在F:wamp\www\test\下面有1.php和2.php其中1.php接受2.php中setco ...

  4. python 跨目录访问文件

    1.同级.同目录的文件之间的访问 有这样一个目录结构 假如,in_A.py 这个文件想调用 hello_world.py 中的函数怎么办呢? --->>>  import 只需在 i ...

  5. Python --判断路径是否为目录或文件

    os.path.isdir( ), os.path.isfile(),os.listdir( ), os.walk( ) 参考网址:https://blog.csdn.net/xxn_723911/a ...

  6. 1. python跨目录调用模块

    快速镜像安装第三方库 :  pip install -i https://pypi.tuna.tsinghua.edu.cn/simple numpy (三方库名字) 同目录下,我们可以直接调用模块, ...

  7. Python练习-跨目录调用模块

    层级结构: dir1 ---hello.py dir2 ---main.py 其中,hello.py: def add(x,y): return x+y main.py如何能调用到hello.py中的 ...

  8. Python跨目录调用模块

    目的就是将脚本执行的根目录加入环境变量. #!/usr/bin/env python3 # -*- coding: utf-8 -*- __author__ = '人生入戏' import os,sy ...

  9. python中os.walk浏览目录和文件

    #!/usr/bin/env python # 2.py # use UTF-8 # Python 3.3.0 # os.walk()的使用 import os # 枚举dirPath目录下的所有文件 ...

随机推荐

  1. 简述ECMAScript6新增特性

    1.变量 var 可以重复声明.只有函数级的作用域.存在变量提升 let 不能重复声明.有块级作用域.没有变量提升.变量 const 不能重复声明.具有块级作用域.常量 2.箭头函数 a.为了方便而存 ...

  2. C语言前置知识汇编基础--总线【地址总线,控制总线,数据总线】练习题

    寻址就是用一个数字表示一个字节存储单元的地址,而不是表示这个存储单元中的内容,所以不用乘以8. 1. 1个CPU的寻址能力为8KB,那么它的地址总线宽度是多少? 8*1024=8192     共有8 ...

  3. 用Node.js给邮箱发送邮件

    首先我们需要做的是下载发送邮件的包 cnpm install nodemailer --save 然后写发送邮件的代码,代码如下: 实现原理是:用你的邮箱给其他邮箱发送邮件,所以这里需要填写你的邮箱和 ...

  4. java基础 Unsafe

    参考文章: https://tech.meituan.com/2019/02/14/talk-about-java-magic-class-unsafe.html

  5. 使用OpenSSL证书操作详解

    一.OpenSSL简介 OpenSSL支持多种秘钥算法,包括RSA.DSA.ECDSA,RSA使用比较普遍.官网地址:https://www.openssl.org/,一般CeontOS系统都装有Op ...

  6. python中count和index

    str = [1,2,3,4,5] #定义一个列表 str = 3 #列表3 str [1, 2, 3, 4, 5, 1, 2, 3, 4, 5, 1, 2, 3, 4, 5] str.count(1 ...

  7. 解决python 缺少os.fspath

    在python3.6下运行pandas会报错缺少os.fspath 升级到python3.7 3.7 安装参考:https://www.cnblogs.com/jifeng/p/11221469.ht ...

  8. LeetCode 142:环形链表 II Linked List Cycle II

    给定一个链表,返回链表开始入环的第一个节点. 如果链表无环,则返回 null. 为了表示给定链表中的环,我们使用整数 pos 来表示链表尾连接到链表中的位置(索引从 0 开始). 如果 pos 是 - ...

  9. php explode容易犯的错误

    php explode容易犯的错误 <pre> $pos = strpos($v, 'Controller'); if (is_numeric($pos)) { $kongzhiqifeg ...

  10. [新概念英语] Lesson 12 : GOODBYE AND GOOD LUCK

    Lesson 12 : GOODBYE AND GOOD LUCK New words and expressions : luck (n) 运气 例句 You're not having much ...