7.16模块及软件开发目录规范

模块

1.什么是模块?

  就是一系列功能的结合体

2.模块的三种来源

  (1)内置的(python解释器自带)

  (2)第三方的(别人写的)

  (3)自定义的(你自己写的)

3.模块的四种表现

  (1)使用python编写的py文件(也就意味着py文件也可以称之为模块:一个py文件也可以称之为一个模块)

  (2)已被编译为共享库或DLL的C或C++扩展(了解)

  (3)把一系列模块组织到一起的文件夹(文件夹下有一个__init__.py文件,该文件夹称之为包)

      包:一系列py文件的结合体

  (4)使用C编写并连接到python解释器的内置模块

4.为什么要用模块

  (1)用别人写好的模块(内置的,第三方的):典型的拿来主义,能够极大的提高开发效率

  (2)使用自己写的模块(自定义的):当程序比较庞大的时候,你的项目不可能只在一个py中,那么当多个文件中都需要使用相同的方法的时候,可以将该公共的方法写到一个py文件中,其他的文件以模块的形式导过去直接调用该方法即可

5.使用模块一定要注意的点

  一定要区分哪个是执行文件,哪个是被导入的文件

import导入模块

import md  # md是需要导入的py文件(模块)

1.导入模块后运行会发生什么

  如果被导入的模块文件名为md.py,执行导入操作的文件是run.py

右键运行run.py,文件首先会创建一个run.py的名称空间

  第一种,首次导入模块的情况:

    (1)运行md.py这个文件

    (2)运行md.py文件中的代码将产生的名字与值存放到md.py名称空间中

    (3)在执行文件(run.py)中,产生一个指向名称空间的名字(md)

  第二种,多次导入同一个模块的情况:

    多次导入不会再执行模块文件,会沿用第一次导入的成果

2.如何访问模块中的名字指向的值 

# 如果md模块中有变量为 money = 1000
import md  # 使用import导入模块
print(md.money)  # 访问模块名称空间中的名字的统一句势为:模块名.名字

使用import导入模块,访问模块名称空间中的名字的统一句势为:模块名.名字

  (1)指名道姓的访问模块中的名字,永远不会与执行文件中的名字冲突

  (2)你如果想访问模块中名字,必须用模块名.名字的方式

3.import还可以同时调用几个模块

import md,os,time  # python支持一行导入多个模块

python支持一行导入多个模块,但是不推荐使用,因为这样结构不清晰,只有当几个模块有相同部分或者属于同一个模块,可以使用上面的方法

当几个模块没有联系的情况下,应该分多次导入:

import md
import os
import time

补充:通常导入模块的句式会写在文件的开头

4.当模块名字比较复杂的情况下可以给该模块名取别名

# 如果模块名特别长比较复杂,可以给该模块取别名
import mddddddddddddd as m
print(m.money)

from...import...导入模块

# 如果md模块中有变量money、函数read1、函数read2...
from md import money,read1,read2
from md import money,read1,read2  # 多次导入不会执行,会沿用第一次导入的成果

1.导入模块后运行会发生什么

  如果被导入的模块文件名为md.py,执行导入操作的文件是run.py

右键运行run.py,文件首先会创建一个run.py的名称空间

  首次导入模块的情况:

    (1)运行md.py这个文件

    (2)运行md.py文件中的代码将产生的名字与值存放到md.py名称空间中

    (3)在执行文件(run.py)中,直接拿到指向模块md.py名称空间中某个值的名字

2.from...import...句式的特点

from md import money
money = '我是执行文件中的money'  # 执行文件中定义一个money
print(money)  # 结果是:我是执行文件中的money
# 模块中money的值会被覆盖,相当于重新赋值了

  (1)访问模块中的名字不需要加模块名前缀

  (2)在访问模块中的名字可能会与当前执行文件中的名字冲突

3.补充

# 如何一次性将md模块中的名字全部加载过来
from md1 import *
print(money)
print(read1)
print(read2)

为什么*可以将一次性将md模块中的名字全部加载过来,其实是拿到__all__中的所有的名字,不写默认所有的,写了就是写多少拿多少

__all__可以指定当所在py文件被当做模块导入的时候,可以限制导入者能够拿到的名字个数

循环导入问题及解决思路

m1模块:

print('正在导入m1')
from m2 import y  # 首次导入m2
x = 'm1'

m2模块:

print('正在导入m2')
from m1 import x  # 第二次导m1
y = 'm2'

执行文件:

from dir1.dir import m1
m1.f1()

  会报错,因为x和y都还没定义

1.如何解决?

(1)方式一:将循环导入的句式写在文件最下方

  修改过的m1模块

print('正在导入m1')
x = 'm1'
from m2 import y  # 首次导入m2

  修改过的m2模块

print('正在导入m2')
y = 'm2'
from m1 import x  # 第二次导m1

  再运行执行文件就不会报错了

from dir1.dir import m1
m1.f1()

(2)方式二:函数内导入模块

  修改过的m1模块

print('正在导入m1')
def f1():
  from dir1.dir.m2 import y,f2
  print('m1.f1>>>y:',y)
  f2()
x = 'm1'

  修改过的m2模块

print('正在导入m2')
def f2():
  from dir1.dir.m1 import x
  print('m2.f2>>>x:',x)
y = 'm2'

  再运行执行文件就不会报错了

from dir1.dir import m1
m1.f1()

2.但是:

  如果出现循环导入问题,那么一定是你的程序设计的不合理,循环导入不应该出现在程序里面,循环导入问题应该在程序设计阶段就避免

__name__用法

1.如何使执行文件调用模块的时候,不执行模块的代码

def index1():
    print('index1')

def index2():
    print('index2')
if __name__ == '__main__':  # 当文件被当做执行文件执行的时候__name__打印的结果是__main__
index1()  # 所以才执行下面的代码
index2()  # 所以才执行下面的代码

  但是当文件被当做模块导入的时候__name__打印的结果是模块的名字,而不再是__main__,所以下面的代码就不会运行了

2.快捷写法

if __name__ == '__main__':  # 快捷写法,只输入main然后直接tab键即可补全

  只输入main然后直接tab键,PyCharm即可帮我们补全

模块的查找顺序

1.模块的查找顺序

  (1)先从内存中找

  (2)然后从内置中找

  (3)再从sys.path中找(类似于环境变量)

import sys
sys.path.append(r'D:Python项目day14dir1')  # 把模块所在的文件夹路径添加到环境变量

  sys是一个模块,sys.path返回的是一个大列表,里面放了一堆文件路径,第一个路径永远是执行sys.path的这个文件所在的文件夹的路径。

  所以使用sys.path的时候一定要分清楚谁是执行文件谁是被导入文件

2.注意:

  py文件名千万不要与模块名(内置的、第三方)相同,冲突了就说明设计不合理

模块的绝对导入和相对导入

1.绝对导入

form dir import m1  # 文件的绝对路径

绝对路径就相当于F:pythonday14代码day14dir1dirm1.py,拿着这个路径无论在哪都能找到要找的对象

  绝对导入必须依据执行文件所在的文件夹路径为准,绝对导入无论在执行文件中还是被导入文件都适用

2.相对导入

  . 代表的当前路径

  .. 代表的上一级路径

  ... 代表的是上上一级路径

  .... 代表的是上上上一级路径

注意:

  相对导入不能在执行文件中使用,只能在被导入的模块中使用,使用相对导入,就不需要考虑执行文件到底是谁,只需要考虑模块与模块之间的路径关系是什么

软件开发目录规范

项目根目录(项目名)

  (1)bin文件夹

    里面放项目启动文件,例如:start.py(启动文件还可以放在根目录下)

# 启动文件的代码
import sys
import os
BASE_DIR = os.path.dirname(os.path.dirname(__file__))  # 获取用户软件根目录的绝对路径
sys.path.append(BASE_DIR)  # 添加到环境变量中
from core import src
if __name__ == '__main__':
    src.run()  # 导入项目的文件并运行
# __file__ 获取当前文件所在文件夹的绝对路径
# os.path.dirname(__file__)获取当前文件所在文件夹往上一层文件夹的绝对路径 
View Code  

  (2)conf文件夹

    里面放项目配置文件,例如:settings.py

  (3)core文件夹

    里面放项目核心逻辑文件,例如:src.py

  (4)db文件夹

    里面放数据相关

  (5)lib文件夹

    里面放项目所用到的公共的功能,例如:common.py

  (6)log文件夹

    里面放项目的日志文件,例如:log.log

  (7)readme文本文件(readme.txt)

    对你这款软件的介绍,介绍项目

原文地址:https://www.cnblogs.com/francis1/p/11197651.html