python基础10-包、代码规范、案例

2020-08-02python

包、代码规范、案例

一、Python中的包

1. 创建包

有 2 个模块功能有些联系，可以将其放到同一个文件夹下
要组成包，还需要在该文件夹中创建__init__.py文件

总结：

把有联系的多个模块文件，放到同一个文件夹下，并且在这个文件夹创建一个名字为__init__.py 文件，那么这个文件夹就称之为包
包的本质就是一个文件夹，包的作用将模块文件组织起来
包能有效避免模块名称冲突问题，提高程序的结构性和可维护性

2. 导入包中模块

使用 import 包名.模块名 能够导入包中的模块
使用 from 包名.模块名 import...能够导入模块中的符号

示例代码：

"""
方式1：
导入格式：   import 包名.模块名
            包名就是文件夹名    模块名就是文件名字
使用格式：   包名.模块名.工具   (类名、函数、变量)
"""
import msg.sendmsg
msg.sendmsg.send_test()

"""
方式2：
导入格式：   from 包名.模块名 import 所需的工具
使用格式：   工具   (类名、函数、变量)
"""
from msg.sendmsg import send_test
# from msg.sendmsg import *
send_test()

3. `init.py`文件有什么用

包被导入时，会执行 __init__.py文件的内容
__init__.py 的作用：控制包的导入行为，管理模块文件

3.1 导包执行`init.py`内容

包被导入时，会执行 __init__.py文件的内容

二、PEP8: Python代码风格指南

PEP8 提供了 Python 代码的编写约定，本节知识点旨在提高代码的可读性，并使其在各种 Python 代码中编写风格保持一致。

缩进使用4个空格, 空格是首选的缩进方式. Python3 不允许混合使用制表符和空格来缩进.
每一行最大长度限制在79个字符以内.
顶层函数、类的定义, 前后使用两个空行隔开.
import 导入
1. 导入建议在不同的行, 例如:
```
import os
import sys
# 不建议如下导包
import os, sys
# 但是可以如下:
from subprocess import Popen, PIPE
```
2. 导包位于文件顶部, 在模块注释、文档字符串之后, 全局变量、常量之前. 导入按照以下顺序分组:
  1. 标准库导入
  2. 相关第三方导入
  3. 本地应用/库导入
  4. 在每一组导入之间加入空行
Python 中定义字符串使用双引号、单引号是相同的, 尽量保持使用同一方式定义字符串. 当一个字符串包含单引号或者双引号时, 在最外层使用不同的符号来避免使用反斜杠转义, 从而提高可读性.
表达式和语句中的空格:
1. 避免在小括号、方括号、花括号后跟空格.
2. 避免在逗号、分好、冒号之前添加空格.
3. 冒号在切片中就像二元运算符, 两边要有相同数量的空格. 如果某个切片参数省略, 空格也省略.
4. 避免为了和另外一个赋值语句对齐, 在赋值运算符附加多个空格.
5. 避免在表达式尾部添加空格, 因为尾部空格通常看不见, 会产生混乱.
6. 总是在二元运算符两边加一个空格, 赋值（=），增量赋值（+=，-=），比较（==,<,>,!=,<>,<=,>=,in,not,in,is,is not），布尔（and, or, not

避免将小的代码块和 if/for/while 放在同一行, 要避免代码行太长.

if foo == 'blah': do_blah_thing()
for x in lst: total += x
while t < 10: t = delay()

永远不要使用字母 ‘l’(小写的L), ‘O’(大写的O), 或者 ‘I’(大写的I) 作为单字符变量名. 在有些字体里, 这些字符无法和数字0和1区分, 如果想用 ‘l’, 用 ‘L’ 代替.
类名一般使用首字母大写的约定.
函数名应该小写, 如果想提高可读性可以用下划线分隔.
如果函数的参数名和已有的关键词冲突, 在最后加单一下划线比缩写或随意拼写更好. 因此 class_ 比 clss 更好.(也许最好用同义词来避免这种冲突).
方法名和实例变量使用下划线分割的小写单词, 以提高可读性.

三、学生名片管理系统：面向对象版

1. 示例代码

import os


class Student(object):
    """学生类：保存学生的基本信息"""
    def __init__(self, name, age, tel):
        self.name = name
        self.age = age
        self.tel = tel

    def __str__(self):
        return f'{self.name}\t{self.age}\t{self.tel}'

    def to_dict(self):
        """将属性内容以字典的形式返回"""
        return {'name': self.name, 'age': self.age, 'tel': self.tel}


class ManagerStuSys(object):
    """管理学生：增删改查学生信息"""
    def __init__(self):
        self.user_list = []

    def test(self):
        s1 = Student('mike', 34, '110')
        s2 = Student('tom', 24, '120')
        self.user_list.append(s1)
        self.user_list.append(s2)
        for obj in self.user_list:
            print(obj)

    def start(self):
        self.load_info()
        while True:
            self.help_menu()
            cmd = input('请输入功能数字：')
            if cmd == '1':
                print('添加学生')
                self.add_info()
            elif cmd == '2':
                print('显示所有学生')
                self.show_all_stu()
            elif cmd == '3':
                print('查询学生信息')
                self.find_stu_by_name()
            elif cmd == '4':
                print('修改学生名片信息')
                self.update_stu_by_name()
            elif cmd == '5':
                print('删除学生信息')
                self.del_stu_by_name()
            elif cmd == '6':
                print('保存信息')
                self.save_info()
            elif cmd == '7':
                print('退出系统')
                break
            else:
                print('输入错误，请重新输入')

    @staticmethod
    def help_menu():
        print('=' * 30)
        print('= 1.添加学生名片信息')
        print('= 2.显示所有学生名片信息')
        print('= 3.查询学生名片信息')
        print('= 4.修改学生名片信息')
        print('= 5.删除学生名片信息')
        print('= 6.保存学生名片信息')
        print('= 7.退出系统')
        print('=' * 30)

    def add_info(self):
        """添加学生名片信息"""
        name = input('请输入姓名：')
        age = int(input('请输入年龄：'))
        tel = input('请输入电话：')

        # 通过for遍历，取出某个元素后，这个元素就是对象
        for obj in self.user_list:
            if obj.name == name:
                print(f'已经存在{name}学生，不能添加')
                break
        else:
            obj = Student(name, age, tel)
            self.user_list.append(obj)
            print(f'{name}学生添加成功')

    def show_all_stu(self):
        """显示所有学生名片信息"""
        if len(self.user_list) == 0:
            print('当前没有任何名片信息')
            return
        # 打印表头
        print('序号\t姓名\t年龄\t电话')
        for i, obj in enumerate(self.user_list):
            print(f'{i+1}\t{obj}')

    def find_stu_by_name(self):
        """查找学生名片信息"""
        name = input('请输入需要查找的姓名：')
        for obj in self.user_list:
            if obj.name == name:
                print(obj)
                break
        else:
            print(f'{name}用户不存在')

    def update_stu_by_name(self):
        """修改学生名片信息"""
        name = input('请输入想要修改的姓名：')
        for i, obj in enumerate(self.user_list):
            if obj.name == name:
                new_name = input('请输入新的名字：')
                new_age = input('请输入新的年龄：')
                new_tel = input('请输入新的电话：')
                self.user_list[i].name = new_name
                self.user_list[i].age = new_age
                self.user_list[i].tel = new_tel
                print('修改成功')
                break
        else:
            print(f'{name}用户不存在')

    def del_stu_by_name(self):
        """删除学生名片信息"""
        name = input('请输入想要删除的姓名：')
        for i, obj in enumerate(self.user_list):
            if obj.name == name:
                del self.user_list[i]
                print('删除成功')
                break
        else:
            print(f'{name}用户不存在')

    def save_info(self):
        """保存学生名片信息"""
        new_list = []
        for obj in self.user_list:
            new_list.append(obj.to_dict())

        with open('stu.txt', 'w') as f:
            f.write(str(new_list))
            print('保存成功')

    def load_info(self):
        """加载文件内容"""
        if not os.path.exists('stu.txt'):
            print('文件不存在，无法加载')
            return

        with open('stu.txt') as f:
            content = f.read()
            temp_list = eval(content)
            print('加载成功')

        for user_dict in temp_list:
            obj = Student(user_dict['name'], user_dict['age'], user_dict['tel'])
            self.user_list.append(obj)


mss = ManagerStuSys()
mss.start()

本文作者：caijinbo
本文链接：https://caijinbo.work/2020/08/02/2020-08-03-python基础10-包、代码规范、案例/
版权声明：本博客所有文章除特殊声明外，均采用 CC BY-NC 4.0 许可协议。转载请注明出处 caijinbo的博客！

python基础10-包、代码规范、案例

包、代码规范、案例

一、Python中的包

1. 创建包

2. 导入包中模块

3. __init__.py文件有什么用

3.1 导包执行__init__.py内容

二、PEP8: Python代码风格指南

三、学生名片管理系统：面向对象版

1. 示例代码

3. `init.py`文件有什么用

3.1 导包执行`init.py`内容