2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-29 13:27:59 +00:00

python: Rename build related code to ovs_build_helpers.

The python/build folder contents are completely unrelated to the ovs
python bindings. These files are only used during the build for various
subsystems (docs, man pages, code generation, etc.).

Having that folder in that location prevents from running:

  cd python && python3 -m build

Which is a way to generate PEP517 compatible source archives and binary
wheel packages.

Rename that folder to ovs_build_helpers which is more explicit. Update
all imports accordingly.

Link: https://peps.python.org/pep-0517/
Link: https://pypi.org/project/build/
Signed-off-by: Robin Jarry <rjarry@redhat.com>
Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
This commit is contained in:
Robin Jarry 2023-08-23 16:29:00 +02:00 committed by Ilya Maximets
parent 785e22f876
commit bb0dd1135b
12 changed files with 27 additions and 25 deletions

View File

@ -415,7 +415,7 @@ endif
CLEANFILES += flake8-check CLEANFILES += flake8-check
-include manpages.mk -include manpages.mk
manpages.mk: $(MAN_ROOTS) build-aux/sodepends.py python/build/soutil.py manpages.mk: $(MAN_ROOTS) build-aux/sodepends.py python/ovs_build_helpers/soutil.py
@PYTHONPATH=$$PYTHONPATH$(psep)$(srcdir)/python $(PYTHON3) $(srcdir)/build-aux/sodepends.py -I. -I$(srcdir) $(MAN_ROOTS) >$(@F).tmp @PYTHONPATH=$$PYTHONPATH$(psep)$(srcdir)/python $(PYTHON3) $(srcdir)/build-aux/sodepends.py -I. -I$(srcdir) $(MAN_ROOTS) >$(@F).tmp
@if cmp -s $(@F).tmp $@; then \ @if cmp -s $(@F).tmp $@; then \
touch $@; \ touch $@; \

View File

@ -4,9 +4,9 @@ import getopt
import sys import sys
import os.path import os.path
import xml.dom.minidom import xml.dom.minidom
import build.nroff
from build.extract_ofp_fields import ( from ovs_build_helpers import nroff
from ovs_build_helpers.extract_ofp_fields import (
extract_ofp_fields, extract_ofp_fields,
PREREQS, PREREQS,
OXM_CLASSES, OXM_CLASSES,
@ -297,7 +297,7 @@ l lx.
body += [".TE\n"] body += [".TE\n"]
body += [".PP\n"] body += [".PP\n"]
body += [build.nroff.block_xml_to_nroff(field_node.childNodes)] body += [nroff.block_xml_to_nroff(field_node.childNodes)]
def group_xml_to_nroff(group_node, fields): def group_xml_to_nroff(group_node, fields):
@ -310,11 +310,11 @@ def group_xml_to_nroff(group_node, fields):
id_ = node.attributes["id"].nodeValue id_ = node.attributes["id"].nodeValue
field_to_xml(node, fields[id_], body, summary) field_to_xml(node, fields[id_], body, summary)
else: else:
body += [build.nroff.block_xml_to_nroff([node])] body += [nroff.block_xml_to_nroff([node])]
content = [ content = [
".bp\n", ".bp\n",
'.SH "%s"\n' % build.nroff.text_to_nroff(title.upper() + " FIELDS"), '.SH "%s"\n' % nroff.text_to_nroff(title.upper() + " FIELDS"),
'.SS "Summary:"\n', '.SS "Summary:"\n',
".TS\n", ".TS\n",
"tab(;),nowarn;\n", "tab(;),nowarn;\n",
@ -422,7 +422,7 @@ ovs\-fields \- protocol header fields in OpenFlow and Open vSwitch
elif node.nodeType == node.COMMENT_NODE: elif node.nodeType == node.COMMENT_NODE:
pass pass
else: else:
s += build.nroff.block_xml_to_nroff([node]) s += nroff.block_xml_to_nroff([node])
for f in fields: for f in fields:
if "used" not in f: if "used" not in f:

View File

@ -2,7 +2,7 @@
import argparse import argparse
import build.extract_ofp_fields as extract_fields from ovs_build_helpers.extract_ofp_fields import extract_ofp_fields
def main(): def main():
@ -19,7 +19,7 @@ def main():
args = parser.parse_args() args = parser.parse_args()
fields = extract_fields.extract_ofp_fields(args.metaflow) fields = extract_ofp_fields(args.metaflow)
field_decoders = {} field_decoders = {}
aliases = {} aliases = {}

View File

@ -14,9 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from build import soutil
import sys import sys
from ovs_build_helpers import soutil
def sodepends(include_dirs, filenames, dst): def sodepends(include_dirs, filenames, dst):
ok = True ok = True

View File

@ -14,9 +14,10 @@
# See the License for the specific language governing permissions and # See the License for the specific language governing permissions and
# limitations under the License. # limitations under the License.
from build import soutil
import sys import sys
from ovs_build_helpers import soutil
def soexpand(include_dirs, src, dst): def soexpand(include_dirs, src, dst):
ok = True ok = True

View File

@ -18,7 +18,7 @@ import getopt
import sys import sys
import xml.dom.minidom import xml.dom.minidom
import build.nroff from ovs_build_helpers import nroff
argv0 = sys.argv[0] argv0 = sys.argv[0]
@ -90,10 +90,10 @@ def manpage_to_nroff(xml_file, subst, include_path, version=None):
. I "\\$1" . I "\\$1"
. RE . RE
.. ..
''' % (build.nroff.text_to_nroff(program), build.nroff.text_to_nroff(section), ''' % (nroff.text_to_nroff(program), nroff.text_to_nroff(section),
build.nroff.text_to_nroff(title), build.nroff.text_to_nroff(version)) nroff.text_to_nroff(title), nroff.text_to_nroff(version))
s += build.nroff.block_xml_to_nroff(doc.childNodes) + "\n" s += nroff.block_xml_to_nroff(doc.childNodes) + "\n"
return s return s
@ -139,7 +139,7 @@ if __name__ == "__main__":
try: try:
s = manpage_to_nroff(args[0], subst, include_path, version) s = manpage_to_nroff(args[0], subst, include_path, version)
except build.nroff.error.Error as e: except nroff.error.Error as e:
sys.stderr.write("%s: %s\n" % (argv0, e.msg)) sys.stderr.write("%s: %s\n" % (argv0, e.msg))
sys.exit(1) sys.exit(1)
for line in s.splitlines(): for line in s.splitlines():

View File

@ -24,7 +24,7 @@ import ovs.json
from ovs.db import error from ovs.db import error
import ovs.db.schema import ovs.db.schema
from build.nroff import * from ovs_build_helpers.nroff import *
argv0 = sys.argv[0] argv0 = sys.argv[0]

View File

@ -66,10 +66,10 @@ ovs_pytests = \
# These python files are used at build time but not runtime, # These python files are used at build time but not runtime,
# so they are not installed. # so they are not installed.
EXTRA_DIST += \ EXTRA_DIST += \
python/build/__init__.py \ python/ovs_build_helpers/__init__.py \
python/build/extract_ofp_fields.py \ python/ovs_build_helpers/extract_ofp_fields.py \
python/build/nroff.py \ python/ovs_build_helpers/nroff.py \
python/build/soutil.py python/ovs_build_helpers/soutil.py
# PyPI support. # PyPI support.
EXTRA_DIST += \ EXTRA_DIST += \
@ -88,10 +88,10 @@ PYCOV_CLEAN_FILES += $(PYFILES:.py=.py,cover)
FLAKE8_PYFILES += \ FLAKE8_PYFILES += \
$(filter-out python/ovs/compat/% python/ovs/dirs.py,$(PYFILES)) \ $(filter-out python/ovs/compat/% python/ovs/dirs.py,$(PYFILES)) \
python/build/__init__.py \ python/ovs_build_helpers/__init__.py \
python/build/extract_ofp_fields.py \ python/ovs_build_helpers/extract_ofp_fields.py \
python/build/nroff.py \ python/ovs_build_helpers/nroff.py \
python/build/soutil.py \ python/ovs_build_helpers/soutil.py \
python/ovs/dirs.py.template \ python/ovs/dirs.py.template \
python/setup.py python/setup.py