From: "Burakov, Anatoly" <anatoly.burakov@intel.com>
To: Bruce Richardson <bruce.richardson@intel.com>, dev@dpdk.org
Cc: thomas@monjalon.net
Subject: Re: [dpdk-dev] [RFC PATCH] devtools: script to check meson indentation of lists
Date: Thu, 22 Apr 2021 10:40:37 +0100 [thread overview]
Message-ID: <b9b6c02e-fb3f-f514-a7fe-bdd35c022512@intel.com> (raw)
In-Reply-To: <20210422090211.320855-1-bruce.richardson@intel.com>
On 22-Apr-21 10:02 AM, Bruce Richardson wrote:
> This is a draft script developed when I was working on the whitespace rework
> changes, since extended a little to attempt to fix some trailing comma issues.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
> devtools/dpdk_meson_check.py | 106 +++++++++++++++++++++++++++++++++++
> 1 file changed, 106 insertions(+)
> create mode 100755 devtools/dpdk_meson_check.py
>
> diff --git a/devtools/dpdk_meson_check.py b/devtools/dpdk_meson_check.py
> new file mode 100755
> index 000000000..dc4c714ad
> --- /dev/null
> +++ b/devtools/dpdk_meson_check.py
> @@ -0,0 +1,106 @@
> +#!/usr/bin/env python3
> +# SPDX-License-Identifier: BSD-3-Clause
> +# Copyright(c) 2021 Intel Corporation
> +
> +'''
> +A Python script to run some checks on meson.build files in DPDK
> +'''
> +
> +import sys
> +import os
> +from os.path import relpath, join
> +from argparse import ArgumentParser
> +
> +VERBOSE = False
> +FIX = False
> +
> +def scan_dir(path):
> + '''return meson.build files found in path'''
> + for root, dirs, files in os.walk(path):
> + if 'meson.build' in files:
> + yield(relpath(join(root, 'meson.build')))
> +
> +
> +def check_indentation(filename, contents):
> + '''check that a list or files() is correctly indented'''
> + infiles = False
> + inlist = False
> + edit_count = 0
> + for lineno in range(len(contents)):
for lineno, line in enumerate(contents)
?
> + line = contents[lineno].rstrip()
> + if not line:
> + continue
> + if line.endswith('files('):
> + if infiles:
> + raise(f'Error parsing {filename}:{lineno}, got "files(" when already parsing files list')
> + if inlist:
> + print(f'Error parsing {filename}:{lineno}, got "files(" when already parsing array list')
> + infiles = True
> + indent = 0
> + while line[indent] == ' ':
> + indent += 1
Here and in other places, if this is measuring length of indent, maybe
do something like:
indent = len(line) - len(line.lstrip(' '))
?
> + indent += 8 # double indent required
> + elif line.endswith('= ['):
> + if infiles:
> + raise(f'Error parsing {filename}:{lineno}, got start of array when already parsing files list')
> + if inlist:
> + print(f'Error parsing {filename}:{lineno}, got start of array when already parsing array list')
> + inlist = True
> + indent = 0
> + while line[indent] == ' ':
> + indent += 1
> + indent += 8 # double indent required
> + elif infiles and (line.endswith(')') or line.strip().startswith(')')):
It's kinda hard to read with all the endswith/startswith, maybe extract
those into a function? e.g. 'elif infiles and is_file_start(line)'
> + infiles = False
> + continue
> + elif inlist and line.endswith(']') or line.strip().startswith(']'):
> + inlist = False
> + continue
> + elif inlist or infiles:
> + # skip further subarrays or lists
> + if '[' in line or ']' in line:
> + continue
I guess you could make it recursive instead of giving up? Does this
happen with any kind of regularity?
> + if not line.startswith(' ' * indent) or line[indent] == ' ':
> + print(f'Error: Incorrect indent at {filename}:{lineno + 1}')
> + contents[lineno] = (' ' * indent) + line.strip() + '\n'
> + line = contents[lineno].rstrip()
> + edit_count += 1
> + if not line.endswith(',') and '#' not in line:
> + # TODO: support stripping comment and adding ','
> + print(f'Error: Missing trailing "," in list at {filename}:{lineno + 1}')
> + contents[lineno] = line + ',\n'
> + line = contents[lineno].rstrip()
What is the point of setting `line` here?
> + edit_count += 1
> + return edit_count
> +
> +
> +def process_file(filename):
> + '''run checks on file "filename"'''
> + if VERBOSE:
> + print(f'Processing {filename}')
> + with open(filename) as f:
> + contents = f.readlines()
I guess meson build files don't get too big so it's OK to read the
entire file in memory and then work on it, rather than go line by line...
> +
> + if check_indentation(filename, contents) > 0 and FIX:
> + print(f"Fixing {filename}")
> + with open(filename, 'w') as f:
> + f.writelines(contents)
> +
> +
> +def main():
> + '''parse arguments and then call other functions to do work'''
> + global VERBOSE
> + global FIX
Seems like globals are unnecessary here when you can just pass them into
process_file?
> + parser = ArgumentParser(description='Run syntax checks on DPDK meson.build files')
> + parser.add_argument('-d', metavar='directory', default='.', help='Directory to process')
> + parser.add_argument('--fix', action='store_true', help='Attempt to fix errors')
> + parser.add_argument('-v', action='store_true', help='Verbose output')
> + args = parser.parse_args()
> +
> + VERBOSE = args.v
> + FIX = args.fix
> + for f in scan_dir(args.d):
> + process_file(f)
> +
> +if __name__ == "__main__":
> + main()
> --
> 2.27.0
>
--
Thanks,
Anatoly
next prev parent reply other threads:[~2021-04-22 9:40 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-21 22:03 [dpdk-dev] [PATCH] drivers: fix indentation in build files Thomas Monjalon
2021-04-22 8:39 ` Bruce Richardson
2021-04-22 9:20 ` Thomas Monjalon
2021-04-26 10:56 ` Bruce Richardson
2021-04-22 9:02 ` [dpdk-dev] [RFC PATCH] devtools: script to check meson indentation of lists Bruce Richardson
2021-04-22 9:40 ` Burakov, Anatoly [this message]
2021-04-22 9:58 ` Bruce Richardson
2021-04-22 10:21 ` Burakov, Anatoly
2021-04-22 10:31 ` Bruce Richardson
2021-04-26 10:54 ` [dpdk-dev] [PATCH v2 1/2] " Bruce Richardson
2021-04-26 10:54 ` [dpdk-dev] [PATCH v2 2/2] build: style fixup on meson files Bruce Richardson
2021-04-26 13:40 ` [dpdk-dev] [PATCH v2 1/2] devtools: script to check meson indentation of lists Burakov, Anatoly
2021-04-26 14:05 ` Bruce Richardson
2021-04-26 14:48 ` Burakov, Anatoly
2021-05-04 13:05 ` Thomas Monjalon
2021-05-04 13:34 ` David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b9b6c02e-fb3f-f514-a7fe-bdd35c022512@intel.com \
--to=anatoly.burakov@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).