输出/打印“可读”字典

2024-01-04

我正在准备一个api,并使用文档字符串作为文档。 api 服务选择相关的 ApiClass 方法并连接每个文档字符串以创建文档。这样,程序开发人员和 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返回最终的文档字符串。因此,当我请求服务文档时,输出非常可读

API服务1

    here is the documentation
        * some thing
        * some other thing
    keep on explanation

API服务2

    Another doc...

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

{1: '某些状态' 2: '其他一些状态消息', 3: '.....', 4: '........', ....}

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

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

有没有办法将我的字典添加到我的响应文档字符串中(在将其返回之前)HttpResponse)而不删除样式缩进?


使用打印:

>>> 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'}
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

输出/打印“可读”字典 的相关文章

随机推荐

  • Scipy:ipython 笔记本中的并行计算?

    我正在做一个kernel density estimation数据集 点的集合 The estimation process没关系 问题是 当我试图获得density value对于每个点 速度都很慢 from sklearn neighb
  • 在 R 中对大数据进行 one-hot 编码的有效方法

    我正在尝试创建我的数据的独热表示 这是我的方法 data iris iris as data frame apply iris 2 function x as factor x head iris iris ohe lt data fram
  • 将控制值作为 html.Pagedlist 参数传递

    我正在使用分页列表来显示值列表 显示器工作正常 我使用提供的 Unobtrusive AJAX 来获取其他页面的数据 这就是我的分页控件的外观 Html PagedListPager Model CountryList page gt Ur
  • 如何在自定义容器视图控制器中实现交互式转换

    我实现了自己的自定义容器视图控制器 并尝试使其与 iOS 7 视图控制器转换兼容 我使我的自定义容器视图控制器符合UIViewControllerContextTransitioning我发送self当我打电话时transitionDura
  • gets() 仅读取换行符时会保存什么

    这是描述gets 来自普拉塔的C 底漆 通常 它从系统的标准输入设备获取一个字符串 你的键盘 因为字符串没有预定的长度 gets 需要一种方法来知道何时停止 它的方法是读取字符 直到到达换行符 n 字符 您生成的 按 Enter 键 它需要
  • 在Google Play商店中,如果生产版本高于测试版本会发生什么?

    假设我当前的版本如下 生产版本代码 1Beta 版本代码 2 只要测试版是最新的代码就一切OK 如果我在生产中更新新版本 版本 3 会发生什么 生产版本代码 3Beta 版本代码 2 我的问题是安装了 versionCode 2 的 bet
  • 从matlab绘图中获取平均值?

    当我有图表时 我有一个简单的图 其中包含大量数据点 有没有一种方法可以让我简单地单击所有这些点并让 matlab 给出它们的平均值 谢谢 另一种选择是使用数据刷 http www mathworks com access helpdesk
  • Laravel Spark 不显示存储在 /storage/app/public/profiles/ 目录中的图像

    上传的图像默认为 storage app public profiles 但前端生成的 URL 为 storage profiles image没有被发现 我尝试为该目录找到任何类型的路由 但未能成功 任何帮助 将不胜感激 您必须链接到存储
  • 转换匿名数组初始值设定项列表

    我可以成功地对 char 字符串数组进行初始化列表的 C 转换 但似乎无法使其与 C 转换 static cast 一起使用 int main char x test 123 This works fine char foo char a
  • 同一 NHibernate Linq 查询中的 Cacheable()、FetchMany() 和 ToFuture()

    存在类似于以下示例的情况 1 个父实体Employee有 2 个子集合 Addresses and Phones 我需要检索single roundtrip所有员工的地址和电话均已初始化 并且cache the query在二级缓存中使用C
  • 正则表达式从英国邮政编码获取区号

    基本上 我需要一个正则表达式来匹配英国邮政编码中的第一个字母序列 简单 和另一个正则表达式来匹配以下数字 不那么容易 可能的组合和匹配示例 AA9A 9AA regex1 AA regex2 9 A9A 9AA regex1 A regex
  • 使用 moment.js 显示本地时区名称

    我在用moment js并想向用户展示本地时区名称 http momentjs com timezone docs using timezones guessing user timezone 例如 CET 或 PST 使用 var tim
  • 将图像置于 Twitter 引导导航栏中居中

    这是我的实时网站 http ancient badlands 4040 herokuapp com http ancient badlands 4040 herokuapp com 我试图将图像居中 并使链接与图像垂直对齐 读完这篇文章后
  • Java 有“可视化调试器”吗? [关闭]

    Closed 这个问题不符合堆栈溢出指南 help closed questions 目前不接受答案 是否有任何 Java 调试器可以显示运行某些代码行时实际发生的情况的逐步动画 我的朋友问了很多Java问题 我现在不知道能否沟通 我也不知
  • 从图库中选定的图像中获取图像的确切文件大小

    这是我的文件选择器代码 private void showFileChooser Intent intent new Intent intent setType image intent setAction Intent ACTION GE
  • React Native Android Bridge 错误:必须在主线程上调用方法 addObserver

    我正在使用 Wootrick SDK 创建一个反应本机的桥梁 当我调用特定函数时 我会收到以下日志 但 Wootric Survey 不会显示 java lang IllegalStateException Method addObserv
  • 在 IntelliJ 中为 Scala 项目设置 Javadoc

    设置 Scaladoc 后 我发现 IDE 中仍然缺少一些文档 在我看来 非常感谢Peter https stackoverflow com users 57695 peter lawrey注意到这一点 非粗体的函数没有文档 粗体字的功能只
  • 无法捕获 playwright 中的 response.json()

    我正在尝试使用 playwright 捕获 json 响应 我不断收到待处理的 Promise 但是 在 headless false 模式下 我可以看到数据正在被接收并填充在浏览器上 我刚刚开始玩Playwright 对 Promise
  • sqlite错误没有这样的列[重复]

    这个问题在这里已经有答案了 这里有人对这个错误有一些经验吗 仅当我使用 WHERE 子句时 才会出现此错误 我使用 php PDO 来获取结果 这是我的简单桌子 sql CREATE TABLE samenvatting stem id I
  • 输出/打印“可读”字典

    我正在准备一个api 并使用文档字符串作为文档 api 服务选择相关的 ApiClass 方法并连接每个文档字符串以创建文档 这样 程序开发人员和 API 用户都可以获得相同的文档 我的班级结构是这样的 API STATUS 1 some