JasonDong97 / learn-python

📚 Python 学习笔记。Python脚本的集合,按目录划分,并包含带解释的代码示例

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Python 学习笔记

Build Status

这是 Python 脚本的集合,按 目录划分,包含带有解释的代码示例、不同的用例和进一步阅读的链接。

这是一个练习场,因为您可以更改或添加代码以查看它是如何工作的, 并使用断言 测试代码。它还允许您 代码检测 并检查它是否符合 Python 代码风格指南。 总而言之,它可能会使您的学习过程更具交互性,并且可能会帮助您从一开始就保持较高的代码质量。

这是一个备忘单,因为一旦您想回顾标准 Python 语句和结构的语法,您可能会回到这些代码示例。 此外,由于代码中充满了断言,您无需启动它们就可以立即看到预期的函数语句输出。

你可能也对🤖感兴趣 交互式机器学习实验

如何使用此存储库

此存储库中的每个 Python 脚本都具有以下结构:

"""Lists  <--- 这里的主题名称

# @see: https://www.learnpython.org/en/Lists  <-- 进一步阅读的链接在这里

这里可能会对当前主题进行更详细的解释(即关于列表的一般信息)。
"""


def test_list_type():
    """
        子主题的解释在这里。每个文件都包含说明子主题的测试函数(即列表类型、列表方法)。
    """
    
    # 以下是如何构建列表的示例。 <-- 这里的评论解释了这个动作
    squares = [1, 4, 9, 16, 25]
    
    # 列表可以被索引和切片。
    # 索引返回项目。
    assert squares[0] == 1  # <-- 这里的断言说明了结果。
    # 切片返回一个新列表。
    assert squares[-3:] == [9, 16, 25]  # <-- 这里的断言说明了结果。

所以通常你可能想要执行以下操作:

  • Find the topic你想学习或回顾。
  • 阅读每个脚本的文档字符串中链接的注释和/或文档(如上例所示)。
  • 查看代码示例和断言以查看使用示例和预期输出。
  • 更改代码或添加新断言以查看工作方式。
  • Run tests and lint the code 看看它是否有效并且是否正确写入。

目录

  1. 入门
  2. 运算符
  3. 数据类型
  4. 控制
  5. 函数
  6. 组件
  7. 错误和异常
  8. 文件
  9. 附加物
  10. 标准库简介

预备知识

安装Python

确保你安装了Python3 on your machine.

你可能想要使用venv标准Python库 创建虚拟环境并安装Python、pip和所有依赖包从本地项目目录提供,以避免与系统范围的包及其版本。

根据你的安装,你可以通过运行pythonpython3。pip包管理器也是如此——它也可能是可访问的 通过运行 pip pip3

You may check your Python version by running:

python --version

Note that in this repository whenever you see python it will be assumed that it is Python 3.

Installing dependencies

Install all dependencies that are required for the project by running:

pip install -r requirements.txt

测试代码

测试使用 pytest 框架.

您可以通过 test_ 作为前缀添加文件和函数为自己添加新的测试 (例如: 在 test_topic.py 里添加 def test_sub_topic() 函数).

要运行所有测试,请从项目根文件夹执行以下命令:

pytest

要运行特定的测试,请执行:

pytest ./path/to/the/test_file.py

代码检测

代码检测用的是 pylintflake8 库.

PyLint

来检查代码是否按 PEP 8 规定编写,请执行:

pylint ./src/

以防linter检测到错误 (i.e. missing-docstring) 你可能想读更多关于 具体运行错误:

pylint --help-msg=missing-docstring

More about PyLint

Flake8

来检查代码是否按 PEP 8 规定编写,请执行:

flake8 ./src

或者,如果你想有更详细的输出,你可以运行:

flake8 ./src --statistics --show-source --count

About

📚 Python 学习笔记。Python脚本的集合,按目录划分,并包含带解释的代码示例

License:MIT License


Languages

Language:Python 100.0%