From patchwork Mon Dec 4 10:24:10 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Juraj_Linke=C5=A1?= X-Patchwork-Id: 134790 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8B7764366A; Mon, 4 Dec 2023 11:24:44 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 34C6040E36; Mon, 4 Dec 2023 11:24:35 +0100 (CET) Received: from mail-wm1-f51.google.com (mail-wm1-f51.google.com [209.85.128.51]) by mails.dpdk.org (Postfix) with ESMTP id 3881640DF5 for ; Mon, 4 Dec 2023 11:24:33 +0100 (CET) Received: by mail-wm1-f51.google.com with SMTP id 5b1f17b1804b1-40c09f5a7cfso11129565e9.0 for ; Mon, 04 Dec 2023 02:24:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1701685473; x=1702290273; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Kn/2U/8Wo1A2Bfu3Vot6EMFi0yZ63e9DkWj/pMBSXyA=; b=JDOL/0ifLfO6hT+RildAXuTPWImFsub/4Zn2Qt0+Cj7ziZ1CgxzJDznhuzMWi+RkQf TM4CB77tCZvRLRDHxHpzP9NNZR9DZQALtv/sjUMFq6ke5vCcfF8JIkLBPkxUt5lySbkN 2uQrxNq1d5DtoTPpy+BSf1uQO+YjNmT6iqCHhF3mACCPHeCSwC10V6IwlrVuszt6Um4Y 3xpB8el2K1Hbf/QuQSUNVjgqrpccsxXxsatZ3zSEmWmtWhLt4GI1Mam6RNEqZWj2Uxw0 LGrkr/9zywTWnrKnBDJpboekklmnykTl5m2ejpFZ3Bd6rCvGptFg1/qiqISVAEukHc/P vf3A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1701685473; x=1702290273; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Kn/2U/8Wo1A2Bfu3Vot6EMFi0yZ63e9DkWj/pMBSXyA=; b=UvDL5eLl4NPfb/6ohPCmfBd7Eac5SK8sXPCix86sjmJOBRvI4PpMrh3Go1aTAlkVVn x+ndbboWk3kIzmFfi2VcODROjWoN2FvKgIWlVyBTbNz4dKSUQVx5ZfCfuA5qd/1YPEWa pV2efk4NZIArsXKfJVB7m0Sduse7N3EfeKU6RC61ss0oURr2C/+mCJ3UcG9wUKBmG6fD GmYiG0bRElURYOlucFa654W6Gt4u7BlV6XKcfQNGnNSDQYv7IIn33UCkAdqXRH/vDhOQ 3wwj5p20tes7OfSuL9KWIgOCJrnU2mXyJ5GMLLY8unA9qD4btdYrRpflL9457u6HAQyH vuPg== X-Gm-Message-State: AOJu0Yxy3JEoEHeKb+eubycB5Aki8fnZRktVmR50XurTlkxP+J/J6zRw hS1DxtVMriQF2B3v4Luuh8wnFA== X-Google-Smtp-Source: AGHT+IFJ1ndvJdHijXOAbbFaBjJogLg35crCfDVc6Rhhd2FtPQ9G4ZhSfaP25Ob/LlfXAOVcK2FpLw== X-Received: by 2002:a05:600c:3115:b0:40b:5e21:ec0e with SMTP id g21-20020a05600c311500b0040b5e21ec0emr2107129wmo.64.1701685472861; Mon, 04 Dec 2023 02:24:32 -0800 (PST) Received: from jlinkes-PT-Latitude-5530.pantheon.local ([81.89.53.154]) by smtp.gmail.com with ESMTPSA id m28-20020a05600c3b1c00b0040b2b38a1fasm14255415wms.4.2023.12.04.02.24.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 04 Dec 2023 02:24:32 -0800 (PST) From: =?utf-8?q?Juraj_Linke=C5=A1?= To: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, yoan.picchi@foss.arm.com, Luca.Vizzarro@arm.com Cc: dev@dpdk.org, =?utf-8?q?Juraj_Linke=C5=A1?= Subject: [PATCH v9 02/21] dts: add docstring checker Date: Mon, 4 Dec 2023 11:24:10 +0100 Message-Id: <20231204102429.106709-3-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231204102429.106709-1-juraj.linkes@pantheon.tech> References: <20231123151344.162812-1-juraj.linkes@pantheon.tech> <20231204102429.106709-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Python docstrings are the in-code way to document the code. The docstring checker of choice is pydocstyle which we're executing from Pylama, but the current latest versions are not complatible due to [0], so pin the pydocstyle version to the latest working version. [0] https://github.com/klen/pylama/issues/232 Signed-off-by: Juraj Linkeš --- dts/poetry.lock | 12 ++++++------ dts/pyproject.toml | 6 +++++- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/dts/poetry.lock b/dts/poetry.lock index f7b3b6d602..a734fa71f0 100644 --- a/dts/poetry.lock +++ b/dts/poetry.lock @@ -489,20 +489,20 @@ files = [ [[package]] name = "pydocstyle" -version = "6.3.0" +version = "6.1.1" description = "Python docstring style checker" optional = false python-versions = ">=3.6" files = [ - {file = "pydocstyle-6.3.0-py3-none-any.whl", hash = "sha256:118762d452a49d6b05e194ef344a55822987a462831ade91ec5c06fd2169d019"}, - {file = "pydocstyle-6.3.0.tar.gz", hash = "sha256:7ce43f0c0ac87b07494eb9c0b462c0b73e6ff276807f204d6b53edc72b7e44e1"}, + {file = "pydocstyle-6.1.1-py3-none-any.whl", hash = "sha256:6987826d6775056839940041beef5c08cc7e3d71d63149b48e36727f70144dc4"}, + {file = "pydocstyle-6.1.1.tar.gz", hash = "sha256:1d41b7c459ba0ee6c345f2eb9ae827cab14a7533a88c5c6f7e94923f72df92dc"}, ] [package.dependencies] -snowballstemmer = ">=2.2.0" +snowballstemmer = "*" [package.extras] -toml = ["tomli (>=1.2.3)"] +toml = ["toml"] [[package]] name = "pyflakes" @@ -837,4 +837,4 @@ jsonschema = ">=4,<5" [metadata] lock-version = "2.0" python-versions = "^3.10" -content-hash = "0b1e4a1cb8323e17e5ee5951c97e74bde6e60d0413d7b25b1803d5b2bab39639" +content-hash = "3501e97b3dadc19fe8ae179fe21b1edd2488001da9a8e86ff2bca0b86b99b89b" diff --git a/dts/pyproject.toml b/dts/pyproject.toml index 980ac3c7db..37a692d655 100644 --- a/dts/pyproject.toml +++ b/dts/pyproject.toml @@ -25,6 +25,7 @@ PyYAML = "^6.0" types-PyYAML = "^6.0.8" fabric = "^2.7.1" scapy = "^2.5.0" +pydocstyle = "6.1.1" [tool.poetry.group.dev.dependencies] mypy = "^0.961" @@ -39,10 +40,13 @@ requires = ["poetry-core>=1.0.0"] build-backend = "poetry.core.masonry.api" [tool.pylama] -linters = "mccabe,pycodestyle,pyflakes" +linters = "mccabe,pycodestyle,pydocstyle,pyflakes" format = "pylint" max_line_length = 100 +[tool.pylama.linter.pydocstyle] +convention = "google" + [tool.mypy] python_version = "3.10" enable_error_code = ["ignore-without-code"]