保姆级教程带你开发优质的Python库之中篇【命令行发行】

本文涉及的产品
全局流量管理 GTM,标准版 1个月
云解析 DNS,旗舰版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 正式的Python专栏第10篇,同学站住,别错过这个从0开始的文章!

前面学委给大家缕一缕了如何开发一个python库并导入运行, 基本完成了一个初步的库


下面指导大家把库做成命令行工具,别人就能像我们使用python或者pip工具一样,输入命令就能使用我们的库!


读者可以查看学委主页加入交流,或者去GitHub给个Star。


把Python库做成命令行的准备

项目结构如下,首先要让它支持命令行。


image.png

记得前面的项目截图里面还有一个setup.py 文件。

setup.py组织了整个项目模块代码和基础信息,支持命令行的诀窍就在里面。

先看一下代码,大家重点观察一个熟悉:entry_points

# -*- coding: utf-8 -*-
# @CSDN/Juejin/Wechat: 雷学委
# @XueWeiTag: OpenSource
# @File : setup.py
# @Project : pypi_seed
from distutils.core import setup
from setuptools import find_packages
setup(name='pypi_seed',  # 包名
      version='1.0.3',  # 版本号
      keywords=("pypi_seed", "seed", "generator", "levin", "leixuewei"),
      description='A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed',
      long_description="""A small tool to demo on upload package to pypi and utility scripts to generate a pypi seed!
Powered by py4ever team!""",
      author='levin',
      author_email='790839397@qq.com', #项目联系人
      url='https://github.com/py4ever/pypi_seed',
      #学委删简了一些,非本文重点的信息
      entry_points={
          'console_scripts': [
              'pypiseed = pypi_seed.main:main',
              'pyseed = pypi_seed.main:main'
          ]
      },
      classifiers=[
          'Intended Audience :: Developers' # 学委删简了一些支持多版本的,需要的去github或者gitee借鉴pypi_seed的setup.py
      ],
      )

解释一下setup.py

简单理解,这个setup.py 就相当于一个开源模块的地图。


它包括了作者信息,项目说明,版本,项目链接,更重要的,安装后命令行的程序入口就放在“entry_points"。


设置了entry_points, 我们使用pip工具安装这个模块的时候,它会自动帮我们创建相应的文件。


比如上面的entry_points是两个命令工具:


pypiseed 为命令行工具,对等与调用pypi_seed.main:main

pyseed 为命令行工具,对等与调用pypi_seed.main:main

补充说明setup.py其他参数解释

重点是作者,项目名称,联系信息,下面整理解释:


name : 项目名称,特别重要!其他开发者通过这个来搜索你的库

author : 作者

keywords : 项目关键字

description : 项目说明

author_email : 作者邮箱信息

url : 项目主页

这些比较直白,根据开源工具的定位来编写完善。


项目说明如果写不下,就放置在long description字段。万一用户在用的时候有啥反馈,还能够联系到邮箱,或者通过项目主页继续互动,这样能够保持项目的不断完善,与时俱进!


第二步 开发一个命令行处理的Python程序

生成了程序入口了,我们可以通过


pyseed  参数 #调用pypi_seed了

好了,说完entry_points, 它调用到了pypi_seed.main:main。 学委已经帮大家看了源码了。


pypiseed / pyseed里面调用了一个程序内的show_help 和args2dict 两个方法。


开源项目源码解析

这里是show_help方法,重点是输出打印一些使用信息,和项目简易说明。


def show_help():
    print('usage:')
    print('-h, --help: print help message.')
    print('-p, --project: your desired project name')
    print('-P, --path: where to save the sample project after code-generation')
    print('-a, --author: the author information')
    print("===========================================")
    show_sample_run()
    show_about()

这里就是本文的核心了,解析用户的输入。

为了解析方便,学委仅摘取了核心代码段,我们看一下。

import sys
import getopt
def args2dict():
    argv = sys.argv[1:]
    if '-h' in argv or '--help' in argv:
        show_help()
        exit(0)
    try:
        opts, args = getopt.getopt(argv, "p:P:a",
                                   ["path=",
                                    "author=",
                                    "project="])
    except Exception as e:
        raise ValueError("Looks like missing value, please check usage by '-h'. Current error : %s " % str(e))
    project = author = path = None
    for opt, arg in opts:
        if opt in ['-p', '--project']:
            project = arg
        elif opt in ['-a', '--author']:
            author = arg
        elif opt in ['-P', '--path']:
            path = arg
    if project is None:
        print("please input project with '-p' or '--project', e.g. -p my_project ")
        raise ValueError("Missing project")
    if author is None:
        print("please input author with '-a' or '--author', e.g. -a whoami ")
        raise ValueError("Missing author")
    if path is None:
        path = os.getcwd()
        print("path is not given, so will use default as current directory : %s" % path)
    return dict(project=project, author=author, path=path)

核心代码讲解

这里主要是分三步


获取终端参数,判断是否输出帮助

使用getopt内置库来解析p:P:a参数(-a, -P, -p) 处理为一个字典dict(管理project/author/path等信息)

返回字典给生成器调用,生成种子项目。

最后使用命令行调用你的库:

安装你的库:


pip install pypi_seed

使用命令如下:

pyseed -p demo_proj -a testuser -P '.'

效果如下,这么简单就生成了,项目了,稍微开发就能成为一个自己的模块,并分享。

image.png

总结

别人找到你的库就很不容易了,命令行的使用也必须力求简洁易懂 ,务必把帮助提示也做的友好一些,方便快速使用嘛!


学会使用setup.py 高效的组织项目代码和配置。

开发命令行工具重点是处理用户输入的参数。

一个优秀的开源项目需要提供简便的使用帮助。

完善的开源项目代码在这:Pypi-Seed on Github


目录
相关文章
|
24天前
|
存储 数据库连接 API
Python环境变量在开发和运行Python应用程序时起着重要的作用
Python环境变量在开发和运行Python应用程序时起着重要的作用
65 15
|
21天前
|
XML 存储 数据库
Python中的xmltodict库
xmltodict是Python中用于处理XML数据的强大库,可将XML数据与Python字典相互转换,适用于Web服务、配置文件读取及数据转换等场景。通过`parse`和`unparse`函数,轻松实现XML与字典间的转换,支持复杂结构和属性处理,并能有效管理错误。此外,还提供了实战案例,展示如何从XML配置文件中读取数据库连接信息并使用。
Python中的xmltodict库
|
20天前
|
BI Python
SciPy 教程 之 Scipy 显著性检验 8
本教程介绍SciPy中显著性检验的应用,包括如何利用scipy.stats模块进行显著性检验,以判断样本与总体假设间的差异是否显著。通过示例代码展示了如何使用describe()函数获取数组的统计描述信息,如观测次数、最小最大值、均值、方差等。
25 1
|
21天前
|
Python
SciPy 教程 之 Scipy 显著性检验 6
显著性检验是统计学中用于判断样本与总体假设间是否存在显著差异的方法。SciPy的scipy.stats模块提供了执行显著性检验的工具,如T检验,用于比较两组数据的均值是否来自同一分布。通过ttest_ind()函数,可以获取两样本的t统计量和p值,进而判断差异是否显著。示例代码展示了如何使用该函数进行T检验并输出结果。
22 1
|
23天前
|
JSON API 数据格式
如何使用Python开发1688商品详情API接口?
本文介绍了如何使用Python开发1688商品详情API接口,获取商品的标题、价格、销量和评价等详细信息。主要内容包括注册1688开放平台账号、安装必要Python模块、了解API接口、生成签名、编写Python代码、解析返回数据以及错误处理和日志记录。通过这些步骤,开发者可以轻松地集成1688商品数据到自己的应用中。
31 1
|
23天前
|
Python
SciPy 教程 之 Scipy 显著性检验 3
本教程介绍Scipy显著性检验,包括其基本概念、原理及应用。显著性检验用于判断样本与总体假设间的差异是否显著,是统计学中的重要工具。Scipy通过`scipy.stats`模块提供了相关功能,支持双边检验等方法。
25 1
|
25天前
|
机器学习/深度学习 Python
SciPy 教程 之 SciPy 插值 2
SciPy插值教程:介绍插值概念及其在数值分析中的应用,特别是在处理数据缺失时的插补和平滑数据集。SciPy的`scipy.interpolate`模块提供了强大的插值功能,如一维插值和样条插值。通过`UnivariateSpline()`函数,可以轻松实现单变量插值,示例代码展示了如何对非线性点进行插值计算。
25 3
|
26天前
|
机器学习/深度学习 数据处理 Python
SciPy 教程 之 SciPy 空间数据 7
本教程介绍了SciPy的空间数据处理功能,涵盖如何使用`scipy.spatial`模块进行点的位置判断、最近点计算等操作。还详细解释了距离矩阵的概念及其在生物信息学中的应用,以及汉明距离的定义和计算方法。示例代码展示了如何计算两个点之间的汉明距离。
30 1
|
22天前
|
Python
SciPy 教程 之 Scipy 显著性检验 5
显著性检验用于判断样本与总体假设间的差异是否由随机变异引起,或是假设与真实情况不符所致。SciPy通过scipy.stats模块提供显著性检验功能,P值用于衡量数据接近极端程度,与alpha值对比以决定统计显著性。
23 0
|
24天前
|
机器学习/深度学习 数据处理 Python
SciPy 教程 之 SciPy 插值 3
本教程介绍了SciPy中的插值方法,包括什么是插值及其在数据处理和机器学习中的应用。通过 `scipy.interpolate` 模块,特别是 `Rbf()` 函数,展示了如何实现径向基函数插值,以平滑数据集中的离散点。示例代码演示了如何使用 `Rbf()` 函数进行插值计算。
23 0