From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 23239433AC; Thu, 23 Nov 2023 16:14:06 +0100 (CET) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id EA6D142FB1; Thu, 23 Nov 2023 16:13:53 +0100 (CET) Received: from mail-lf1-f44.google.com (mail-lf1-f44.google.com [209.85.167.44]) by mails.dpdk.org (Postfix) with ESMTP id C2D5F42F9B for ; Thu, 23 Nov 2023 16:13:49 +0100 (CET) Received: by mail-lf1-f44.google.com with SMTP id 2adb3069b0e04-507c5249d55so1381388e87.3 for ; Thu, 23 Nov 2023 07:13:49 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon.tech; s=google; t=1700752429; x=1701357229; 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=rEVnuHKtAwjSyuTYbktFIC6jSybru5qg0csp1le4cGhiSNqPsIDZnoMlfGxVpCHx7L GLU/H3NjqLE1GzUsKz7VpfZzgNEpCbT2z0vQ+KXjnHWIjjYoPLsgg8kNiQ1TQ1lzmmyR gF6ELAZDxiWwoWFX+YrPC5MOzYxTomfXjHus8rsbAqXIK6sNKx7kismJ3smIjC58wh4G ++4NYmoKc4022VPLYP2mEzsZYVThcbk+zdBLY0Ptwzh0orjmMVoto0ojfstMiSocXlBS e3A4CsMD6Ax4fGRGkIqLgcOphTQHZkp620NBeBM19ifQBuntRsslm4gzhA0UO8Jxp/tg qE5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700752429; x=1701357229; 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=A6e9BIZ/wVDA7NY8PumQORjyCuVaRiuF6/j7JeFWL++AT7ewi74PfieH7M7rdNb7uJ jzhCgb/+CW+6tH/hjZ76WtsCuK39U1xLwefVLe7U8bgCJJ0tav2UWUemTaAvID8Y8wSk dAxX2C4a7QkFoDWhNb/2AB9vUE+1BOsb/nT0ugsvRHsKkpsPW4aK2BdGVoeE1mOgCEcS aAoS68APuAGg/agGBu/EjO9PT+uVWw9rajHzu1/PA6Co3+yRhJKngnVcxrCMai/ITpD2 Q1YQB+vKr1lG96PNHLy2RzncUPz4EkPbMCpTus57iA0Lawi6MxJwfMqCoAMTWmo7Fzqh 7Lqw== X-Gm-Message-State: AOJu0Yz4KjHwbdPBJkYliKre9NqXH1Hx4MxqHSnnh/v9o6WfZaQMVKQJ GhTPP3JOQvYp7ddL2kiWoWJFjg== X-Google-Smtp-Source: AGHT+IEeJ4giSaObXfzA3wq8VhC4jif3ju5BERjflnKKi14RXqH+/R2z60ibKW1J4QsN9r9Gd8/eMA== X-Received: by 2002:a19:4f01:0:b0:509:8e20:e7c6 with SMTP id d1-20020a194f01000000b005098e20e7c6mr2162765lfb.32.1700752429217; Thu, 23 Nov 2023 07:13:49 -0800 (PST) Received: from jlinkes-PT-Latitude-5530.. ([84.245.121.10]) by smtp.gmail.com with ESMTPSA id q4-20020adfea04000000b003296b488961sm1870143wrm.31.2023.11.23.07.13.47 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 23 Nov 2023 07:13:48 -0800 (PST) From: =?UTF-8?q?Juraj=20Linke=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=20Linke=C5=A1?= Subject: [PATCH v8 02/21] dts: add docstring checker Date: Thu, 23 Nov 2023 16:13:25 +0100 Message-Id: <20231123151344.162812-3-juraj.linkes@pantheon.tech> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20231123151344.162812-1-juraj.linkes@pantheon.tech> References: <20231115130959.39420-1-juraj.linkes@pantheon.tech> <20231123151344.162812-1-juraj.linkes@pantheon.tech> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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"] -- 2.34.1