* Adding support for YAML width

cdgriffith · cdgriffith · commit a6b71cb7b4fa · 2026-02-19T21:14:31.000-06:00
* Adding support for Python 3.14
* Removing support for Python 3.9 as it is EOL
diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -18,7 +18,7 @@ jobs:
     - name: Set up Python
       uses: actions/setup-python@v5
       with:
-        python-version: '3.13'
+        python-version: '3.14'
 
     - name: Install Dependencies
       run: |
@@ -39,7 +39,7 @@ jobs:
     strategy:
       matrix:
         os: [macos-latest, windows-latest]
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
     runs-on: ${{ matrix.os }}
 
     steps:
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -13,7 +13,7 @@ jobs:
   package-checks:
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "pypy-3.10"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14", "pypy-3.10"]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
@@ -98,7 +98,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,13 @@
 Changelog
 =========
 
+Version 7.4.0
+-------------
+
+* Adding support for YAML width
+* Adding support for Python 3.14
+* Removing support for Python 3.9 as it is EOL
+
 Version 7.3.2
 -------------
 
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017-2023 Chris Griffith
+Copyright (c) 2017-2026 Chris Griffith
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.rst b/README.rst
@@ -139,7 +139,7 @@ Also special shout-out to PythonBytes_, who featured Box on their podcast.
 License
 =======
 
-MIT License, Copyright (c) 2017-2023 Chris Griffith. See LICENSE_ file.
+MIT License, Copyright (c) 2017-2026 Chris Griffith. See LICENSE_ file.
 
 
 .. |BoxImage| image:: https://raw.githubusercontent.com/cdgriffith/Box/master/box_logo.png
diff --git a/box/__init__.py b/box/__init__.py
@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 
 __author__ = "Chris Griffith"
-__version__ = "7.3.2"
+__version__ = "7.3.3"
 
 from box.box import Box
 from box.box_list import BoxList
diff --git a/box/box.py b/box/box.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2017-2023 - Chris Griffith - MIT License
+# Copyright (c) 2017-2026 - Chris Griffith - MIT License
 """
 Improved dictionary access through dot notation with additional tools.
 """
@@ -1002,6 +1002,7 @@ def to_yaml(
             default_flow_style: bool = False,
             encoding: str = "utf-8",
             errors: str = "strict",
+            width: int = 120,
             **yaml_kwargs,
         ):
             """
@@ -1011,6 +1012,7 @@ def to_yaml(
             :param default_flow_style: False will recursively dump dicts
             :param encoding: File encoding
             :param errors: How to handle encoding errors
+            :param width: Line width for YAML output
             :param yaml_kwargs: additional arguments to pass to yaml.dump
             :return: string of YAML (if no filename provided)
             """
@@ -1020,6 +1022,7 @@ def to_yaml(
                 default_flow_style=default_flow_style,
                 encoding=encoding,
                 errors=errors,
+                width=width,
                 **yaml_kwargs,
             )
 
@@ -1062,6 +1065,7 @@ def to_yaml(
             default_flow_style: bool = False,
             encoding: str = "utf-8",
             errors: str = "strict",
+            width: int = 120,
             **yaml_kwargs,
         ):
             raise BoxError('yaml is unavailable on this system, please install the "ruamel.yaml" or "PyYAML" package')
diff --git a/box/box.pyi b/box/box.pyi
@@ -93,6 +93,7 @@ class Box(dict):
         default_flow_style: bool = ...,
         encoding: str = ...,
         errors: str = ...,
+        width: int = ...,
         **yaml_kwargs,
     ): ...
     @classmethod
diff --git a/box/box_list.py b/box/box_list.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# Copyright (c) 2017-2023 - Chris Griffith - MIT License
+# Copyright (c) 2017-2026 - Chris Griffith - MIT License
 import copy
 import re
 from os import PathLike
@@ -98,7 +98,7 @@ def __setitem__(self, key, value):
                 self.extend([None] * (pos - len(self) + 1))
             if len(list_pos.group()) == len(key):
                 return super().__setitem__(pos, value)
-            children = key[len(list_pos.group()):].lstrip(".")
+            children = key[len(list_pos.group()) :].lstrip(".")
             if self.box_options.get("default_box"):
                 if children[0] == "[":
                     super().__setitem__(pos, box.BoxList(**self.box_options))
@@ -258,6 +258,7 @@ def to_yaml(
             default_flow_style: bool = False,
             encoding: str = "utf-8",
             errors: str = "strict",
+            width: int = 120,
             **yaml_kwargs,
         ):
             """
@@ -267,6 +268,7 @@ def to_yaml(
             :param default_flow_style: False will recursively dump dicts
             :param encoding: File encoding
             :param errors: How to handle encoding errors
+            :param width: Line width for YAML output
             :param yaml_kwargs: additional arguments to pass to yaml.dump
             :return: string of YAML or return of `yaml.dump`
             """
@@ -276,6 +278,7 @@ def to_yaml(
                 default_flow_style=default_flow_style,
                 encoding=encoding,
                 errors=errors,
+                width=width,
                 **yaml_kwargs,
             )
 
@@ -318,6 +321,7 @@ def to_yaml(
             default_flow_style: bool = False,
             encoding: str = "utf-8",
             errors: str = "strict",
+            width: int = 120,
             **yaml_kwargs,
         ):
             raise BoxError('yaml is unavailable on this system, please install the "ruamel.yaml" or "PyYAML" package')
diff --git a/box/box_list.pyi b/box/box_list.pyi
@@ -49,6 +49,7 @@ class BoxList(list):
         default_flow_style: bool = ...,
         encoding: str = ...,
         errors: str = ...,
+        width: int = ...,
         **yaml_kwargs: Any,
     ) -> Any: ...
     @classmethod
diff --git a/box/converters.py b/box/converters.py
@@ -185,6 +185,7 @@ def _to_yaml(
     errors: str = "strict",
     ruamel_typ: str = "rt",
     ruamel_attrs: Optional[Dict] = None,
+    width: int = 120,
     **yaml_kwargs,
 ):
     if not ruamel_attrs:
@@ -195,25 +196,27 @@ def _to_yaml(
             if ruamel_available:
                 yaml_dumper = YAML(typ=ruamel_typ)
                 yaml_dumper.default_flow_style = default_flow_style
+                yaml_dumper.width = width
                 for attr, value in ruamel_attrs.items():
                     setattr(yaml_dumper, attr, value)
                 return yaml_dumper.dump(obj, stream=f, **yaml_kwargs)
             elif pyyaml_available:
-                return yaml.dump(obj, stream=f, default_flow_style=default_flow_style, **yaml_kwargs)
+                return yaml.dump(obj, stream=f, default_flow_style=default_flow_style, width=width, **yaml_kwargs)
             else:
                 raise BoxError(MISSING_PARSER_ERROR)
 
     else:
         if ruamel_available:
             yaml_dumper = YAML(typ=ruamel_typ)
             yaml_dumper.default_flow_style = default_flow_style
+            yaml_dumper.width = width
             for attr, value in ruamel_attrs.items():
                 setattr(yaml_dumper, attr, value)
             with StringIO() as string_stream:
                 yaml_dumper.dump(obj, stream=string_stream, **yaml_kwargs)
                 return string_stream.getvalue()
         elif pyyaml_available:
-            return yaml.dump(obj, default_flow_style=default_flow_style, **yaml_kwargs)
+            return yaml.dump(obj, default_flow_style=default_flow_style, width=width, **yaml_kwargs)
         else:
             raise BoxError(MISSING_PARSER_ERROR)
 
diff --git a/box/converters.pyi b/box/converters.pyi
@@ -28,6 +28,7 @@ def _to_yaml(
     errors: str = ...,
     ruamel_typ: str = ...,
     ruamel_attrs: Optional[Dict] = ...,
+    width: int = ...,
     **yaml_kwargs,
 ): ...
 def _from_yaml(
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -2,7 +2,7 @@ coverage>=7.6.9
 msgpack>=1.0
 pytest>=7.1.3
 pytest-cov<6.0.0
-ruamel.yaml>=0.17
+ruamel.yaml>=0.19.1
 tomli>=1.2.3; python_version < '3.11'
 tomli-w>=1.0.0
 types-PyYAML>=6.0.3
diff --git a/requirements.txt b/requirements.txt
@@ -1,4 +1,4 @@
 msgpack>=1.0.0
-ruamel.yaml>=0.17
+ruamel.yaml>=0.19.1
 tomli>=1.2.3; python_version < '3.11'
 tomli-w
diff --git a/setup.py b/setup.py
@@ -51,11 +51,11 @@
     classifiers=[
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
         "Programming Language :: Python :: 3.12",
         "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
         "Programming Language :: Python :: Implementation :: CPython",
         "Development Status :: 5 - Production/Stable",
         "Natural Language :: English",
@@ -67,9 +67,9 @@
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],
     extras_require={
-        "all": ["ruamel.yaml>=0.17", "toml", "msgpack"],
-        "yaml": ["ruamel.yaml>=0.17"],
-        "ruamel.yaml": ["ruamel.yaml>=0.17"],
+        "all": ["ruamel.yaml>=0.19.1", "toml", "msgpack"],
+        "yaml": ["ruamel.yaml>=0.19.1"],
+        "ruamel.yaml": ["ruamel.yaml>=0.19.1"],
         "PyYAML": ["PyYAML"],
         "tomli": ["tomli; python_version < '3.11'", "tomli-w"],
         "toml": ["toml"],
diff --git a/test/test_box.py b/test/test_box.py
@@ -221,6 +221,14 @@ def test_to_yaml_file(self):
             data = yaml.load(f)
             assert data == test_dict
 
+    def test_to_yaml_width(self):
+        long_value = "a " * 80  # 160 character string
+        a = Box({"key": long_value.strip()})
+        narrow = a.to_yaml(width=40)
+        wide = a.to_yaml(width=200)
+        # With width=200, the value should fit on fewer lines than width=40
+        assert len(wide.splitlines()) < len(narrow.splitlines())
+
     def test_dir(self):
         a = Box(test_dict, camel_killer_box=True)
         assert "key1" in dir(a)
diff --git a/test/test_converters.py b/test/test_converters.py
@@ -94,11 +94,5 @@ def test_to_msgpack(self):
 
     def test_to_yaml_ruamel(self):
         movie_string = _to_yaml(movie_data, ruamel_attrs={"width": 12})
-        multiline_except = """    - name: Roger
-        Rees
-      imdb: nm0715953
-      role: Sheriff
-        of Rottingham
-    - name: Amy
-        Yasbeck"""
+        multiline_except = """    - name: \n        Roger\n        Rees\n      imdb: \n        nm0715953\n      role: \n        Sheriff\n        of \n        Rottingham\n    - name: \n        Amy \n        Yasbeck"""
         assert multiline_except in movie_string
