Skip to content

Allow non-delimiting quotes in space-delimited data #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 31 commits into from
Mar 17, 2025

Conversation

janbridley
Copy link
Collaborator

@janbridley janbridley commented Mar 17, 2025

Description

When testing a fixed-precision unit cell builder implementation, I ran into a pattern in AFLOW's tabular data that broke parsnip's parsing engine. To fix this, I added an extra conditional check to the space_delimited_data regular expression.
The new pattern allows for single-quoted strings that contain single quotes that are not followed by a space (as this would indicate a delimiting whitespace). I did need to use some non-capturing groups for this pattern, but there are no lookahead/lookbehinds or labeled groups so the expression should never get catastrophic.

- r"\'[^'])*\'"
+ r"\'(?:'[^\s]|[^'])*\'"
# Data delimited by single quotes, which may contain other single quotes as long as they are not followed by a space

See point 15 from the CIF spec for examples of the pattern that was encountered here.

Previously-invalid string examples:

'Michael O'Keeffe'
'C. H\'{e}rold'
'J. F. Mar\^{e}ch\'{e}'

Outstanding issues:

Data entries that end with two single quotes in a row and are the last entry in a loop row will be terminated by only one of the two single quotes. I could fix this with some lookahead checks, but at the cost of a significant performance hit.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality and should be merged into the breaking branch

Checklist:

  • I am familiar with the Development Guidelines
  • The changes introduced by this pull request are covered by existing or newly introduced tests.
  • I have updated the changelog and added my name to the credits.

@janbridley janbridley changed the title Feat/nondelimiting quotes Allow non delimiting quotes in table data Mar 17, 2025
@janbridley janbridley changed the title Allow non delimiting quotes in table data Allow non-delimiting quotes in table data lines Mar 17, 2025
@janbridley janbridley marked this pull request as ready for review March 17, 2025 20:45
@janbridley janbridley changed the title Allow non-delimiting quotes in table data lines Allow non-delimiting quotes in space-delimited data Mar 17, 2025
@janbridley janbridley merged commit a0f4dcf into main Mar 17, 2025
16 checks passed
@janbridley janbridley deleted the feat/nondelimiting-quotes branch March 17, 2025 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant