Expose stringify_id at top level and add optional parameter escape_css

[anders-kiaer]

Closes #1625 (except the dash-docs part - but I can take that after review and if accepted).

Contributor Checklist

• I have broken down my PR scope into the following TODO tasks
  • Expose stringify_id at top level.
  • Add css_escape function.
• I have run the tests locally and they passed. (refer to testing section in contributing)
• I have added tests, or extended existing tests, to cover any new features or bugs fixed in this PR

optionals

• I have added entry in the CHANGELOG.md
• If this PR needs a follow-up in dash docs, community thread, I have mentioned the relevant URLS as follows
  • this GitHub #PR number updates the dash docs
  • here is the show and tell thread in Plotly Dash community

[anders-kiaer]

There is an easy possibility of extending

dash/dash/testing/browser.py

Lines 277 to 288 in e8ac949

	def wait_for_element_by_id(self, element_id, timeout=None):
	"""Explicit wait until the element is present, timeout if not set,
	equals to the fixture's `wait_timeout` shortcut to `WebDriverWait` with
	`EC.presence_of_element_located`."""
	return self._wait_for(
	EC.presence_of_element_located,
	((By.ID, element_id),),
	timeout,
	"timeout {}s => waiting for element id {}".format(
	timeout if timeout else self._wait_timeout, element_id
	),
	)

to check if input element_id is dict, and then do dash.stringify_id(element_id, escape_css=True) for the user in the wait_for_element_by_id function.

The user's test line here

assert dash_duo.wait_for_element_by_id(dash.stringify_id(id, escape_css=True))

then becomes

assert dash_duo.wait_for_element_by_id(id)

both in the case with string IDs, and dictionary IDs (when you use pattern-matching callbacks).

Not sure if that is too magical 🔮 or a nice and easy to understand convenience.

[T4rk1n]

Good idea with extending the testing utilities, I think that is where most cases would be for escaping.

[gvwilson]

hi @T4rk1n - is this one still relevant or has it gone stale?

[T4rk1n]

Sorry this PR fell under the cracks, I think this is still good, just need to update with dev branch which include new code for stringify_id

[T4rk1n]

I would maybe rename to escape_css_id.

[T4rk1n]

Could also expose css_escape

[T4rk1n]

Good idea with extending the testing utilities, I think that is where most cases would be for escaping.

[gvwilson]

thanks @T4rk1n - I'll add it to the pile for the next cycle (no need to work on it right now). Cheers - @gvwilson