foamlib v1.5.0

New features

New parser for FoamFile

New custom recursive descent–based parser written in vanilla Python delivers additional type safety, better error messages, and a very significant speed boost when parsing binary files.

foamlib.typing

Type hints that were already used internally by foamlib are now also available for users who want to use them in their code.

run_all static method in AsyncFoamCase

Convenience method for easily running multiple cases in parallel.

All changes

• Add run_all and run_all_wait static methods to AsyncFoamCase by @gerlero in https://github.com/gerlero/foamlib/pull/682
• Fix docstrings by @gerlero in https://github.com/gerlero/foamlib/pull/683
• Expose typing module by @gerlero in https://github.com/gerlero/foamlib/pull/684
• Rename File type alias to FileDict by @gerlero in https://github.com/gerlero/foamlib/pull/685
• Implement custom recursive descent parser for FoamFile.loads by @gerlero in https://github.com/gerlero/foamlib/pull/686
• Switch ParsedFile to new custom parser with location tracking by @Copilot in https://github.com/gerlero/foamlib/pull/687
• Fix subdictionary entry update accumulating blank lines and indentation by @Copilot in https://github.com/gerlero/foamlib/pull/690
• Fix parsing by @gerlero in https://github.com/gerlero/foamlib/pull/691
• Improve FoamFile parse error handling by @gerlero in https://github.com/gerlero/foamlib/pull/692
• Improve number parsing by @gerlero in https://github.com/gerlero/foamlib/pull/693
• Remove regex library dependency from token parser by @Copilot in https://github.com/gerlero/foamlib/pull/694
• Drop dependency on PyParsing by @gerlero in https://github.com/gerlero/foamlib/pull/695
• Improve token parsing by @gerlero in https://github.com/gerlero/foamlib/pull/696
• Refactor parse_file_located to return flattened MultiDict and implement single-pass parsing by @Copilot in https://github.com/gerlero/foamlib/pull/697
• Decode ASCII numeric lists for NumPy for improved parsing performance by @gerlero in https://github.com/gerlero/foamlib/pull/698
• Update parse exception classes by @gerlero in https://github.com/gerlero/foamlib/pull/699
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/700
• Remove AsyncFoamCase.run_all_wait method by @gerlero in https://github.com/gerlero/foamlib/pull/701
• Simplify parser by @gerlero in https://github.com/gerlero/foamlib/pull/702
• Improve typing module by @gerlero in https://github.com/gerlero/foamlib/pull/703
• Make lazy FoamFile parsing thread-safe for extra transparency by @gerlero in https://github.com/gerlero/foamlib/pull/704
• Do not use FoamFile as context manager in non-mutating operations by @gerlero in https://github.com/gerlero/foamlib/pull/705
• Fix exit race condition between context depth and modified flag by @Copilot in https://github.com/gerlero/foamlib/pull/708
• Add extra assertion to FoamFile IO by @gerlero in https://github.com/gerlero/foamlib/pull/707
• Optimize len and contains via direct parsed data access by @Copilot in https://github.com/gerlero/foamlib/pull/706
• Switch from bytes to bytearray for parsed content by @gerlero in https://github.com/gerlero/foamlib/pull/709
• Fix failing parsing tests by @gerlero in https://github.com/gerlero/foamlib/pull/710
• Inline dict_from_items into normalized to remove unnecessary abstraction by @Copilot in https://github.com/gerlero/foamlib/pull/711
• Update index.rst by @gerlero in https://github.com/gerlero/foamlib/pull/713
• Fix formatting loss when editing subdictionary entries (FoamFile header) by @Copilot in https://github.com/gerlero/foamlib/pull/712
• Update README.md by @gerlero in https://github.com/gerlero/foamlib/pull/714
• Update benchmark by @gerlero in https://github.com/gerlero/foamlib/pull/715

Full Changelog: https://github.com/gerlero/foamlib/compare/v1.4.5...v1.5.0