Skip to content
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

set regex pattern for CURIE and add URL, fixes #400 #406

Open
wants to merge 3 commits into
base: 1.4
Choose a base branch
from

Conversation

sierra-moxon
Copy link
Member

  • regexes are fairly permissive taking into account that CURIE syntax in the "wild" might be less conformant to prefix best practices.
  • the ticket called for a URL type, if we want a semantic URI type (where the URI can be the subject of a triple in RDF), then we should be much more restrictive. When we have a specific use case for this, I'd be happy to refine it.

Copy link
Collaborator

@edeutsch edeutsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay with me in principle, but I don't think the regular expression seems helpful. Is there a "standard" regexp for URLs out there on stack overflow or somewhere?

description: >-
externalDocs:
url: https://www.ietf.org/rfc/rfc3987.txt
pattern: ^(http(s)?:\/\/.)?(www\.)?\S+$
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this regular expression anything without a space? Is that really helpful? Testing this regexp:

#!/bin/env python3
import re

inputs = [ 'http://arax.ncats.io', 'foo', '@*$&@#', 'PMID:123', 'http://peptideatlas.org/tmp/hello world.txt' ]

for input in inputs:
    match = re.search(r'^(http(s)?:\/\/.)?(www\.)?\S+$', input)
    if match:
        print(f"MATCHES {input}")
    else:
        print(f"    x   {input}")

yields

MATCHES http://arax.ncats.io
MATCHES foo
MATCHES @*$&@#
MATCHES PMID:123
    x   http://peptideatlas.org/tmp/hello world.txt

only the last one fails.

Yet if you paste that into your browser, it works!

Maybe this is useful with a more restrictive regular expression?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My first thought too was to find a more comprehensive one. The one I found and tested that was more restrictive did fail the line length linting on this repo and before I tried to break it into many lines, I started asking around a bit for best practice on this. The feedback I got was that a very restrictive regex will mean constant tweaking with "in the wild" implementations of URLs and CURIEs. However, if we want to have a URI (not L) type, that is much more restrictive, we can do that.

edeutsch added a commit that referenced this pull request Mar 21, 2023
Copy link
Collaborator

@vdancik vdancik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that specifying regex in specification is not necessary

@edeutsch edeutsch added this to the v1.5 milestone Apr 27, 2023
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.

3 participants