feat: optionally disable path encoding about imgix-python HOT 5 CLOSED

Hey @ashutoshkrris, apologies for the confusion I'll try and make the task a little clearer.

If disablePathEncoding is set to true then the parts of the path that do not adhere to the URL spec should not be encoded.

For example:

When disablePathEncoding is set to false, IE the default behavior

• http://sdk-test.imgix.net/ <>[]{}|^%.jpg → http://sdk-test.imgix.net/%20%3C%3E[]%7B%7D%7C/%5E%.jpg
• http://www.example.com/products/123 → http://www.example.com/products/123

When disablePathEncoding is set to true

• http://sdk-test.imgix.net/ <>[]{}|^%.jpg → http://sdk-test.imgix.net/ <>[]{}|^%.jpg
• http://www.example.com/products/123 → http://www.example.com/products/123

As a suggestion, you could do some test-driven development (TDD) here by creating a variant of these tests. They should test that settings disablePathEncoding esnures the URL does not get encoded.

To run those tests, in the project root you'll need to run:

• pip install ".[test]"
• pip install tox
• tox

from imgix-python.

Hi @luqven
I would like to work on this issue.

from imgix-python.

Hey @ashutoshkrris 👋 ,

Glad to hear it! I'll marked this issue as assigned to you.

In terms of next steps, please either comment here or open a RFC (request for comment) draft PR explaining the change you'd like to implement.

You can also take a look at our contributing guidelines to get you started.

If you have any trouble at all getting setup or have any questions, don't hesitate to comment here and tag a team member.

from imgix-python.

Thanks for assigning me the issue, @luqven.
Just to confirm, we have these conditions:

• If disablePathEncoding is set to True, then http://www.example.com/products/123 will have no change.
• If disablePathEncoding is set to False, then http://www.example.com/products/123 will be converted to http://www.example.com/products%2F123.

Is what I understand correct?

from imgix-python.

@luqven
In order to add the optional disable_path_encoding functionality, I'd like to make the following changes:

1. Add _disable_path_encoding in the constructor of UrlBuilder class with a default value of False.
2. Update the _sanitize_path method to use the _disable_path_encoding variable.
3. Add more testcases in test_url_builder and test_srcset to cover the new scenarios.

Let me know if I am missing something.

from imgix-python.