python – 输出/打印“可读”字典

发布时间：2020-12-20 12:28:21 所属栏目：Python 来源：网络整理

导读：我正在准备api,并使用docstrings作为文档. api服务选择相关的ApiClass方法并连接每个docstring以创建文档.这样,api的程序开发人员和用户都达到了相同的文档. 我的班级结构如下： API_STATUS = { 1: 'some status',2: 'some other status message'}class MyAp

我正在准备api,并使用docstrings作为文档. api服务选择相关的ApiClass方法并连接每个docstring以创建文档.这样,api的程序开发人员和用户都达到了相同的文档.

我的班级结构如下：

API_STATUS = {
    1: 'some status',2: 'some other status message'
}

class MyApi:
    def __init__(self):
        blah blah blah

    def ApiService1(self,some_param):
        """ 
        here is the documentation
            * some thing
            * some other thing
        keep on explanation
        """
        do some job 

    def  ApiService2(self,some_param):
        """"
        Another doc...
        """
        do some other job

我正在使用HttpResponse返回最终的文档字符串.因此,当我请求服务文档时,输出非常易读

ApiService1

06001

ApiService2

06002

一切都很好,但有一些变量,如API_STATUS字典和一些列表,我希望将它们添加到文档中.但是当我将它们解析为字符串或调用repr函数时,所有格式都消失了

{1: ‘some status’ 2: ‘some other status message’,3: ‘…..’,4: ‘……..’,….}

这使得它不可读(因为dict有大约50个元素.).

我不想写作文档字符串(因为在将来的更新中,相关的字典可能会被更新,dicstring可能会被遗忘)

有没有办法将我的字典添加到我的响应文档字符串(在返回它作为HttpResponse之前)而不删除sytling缩进？

解决方法

使用pprint：

>>> API_STATUS = {1: 'some status',2: 'some other status message'}
>>> import pprint
>>> pprint.pprint(API_STATUS,width=1)
{1: 'some status',2: 'some other status message'}

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!