get_filename_safe_course_id

[ji...@opencraft.com]

Hello,

I'm wondering whether it would be ok to move the edx-analytics-pipeline method opaque_key_util.get_filename_safe_course_id() into the edx-opaque-keys repository.

This method is currently also defined (identically) in edx-analytics-exporter.course_export, and we've got a PR in review for the edx-analytics-data-api that would also find it useful.

Does this sound ok?

Any preferences on where it should live in opaque_keys?

--

Jill

@OpenCraft

[David Ormsbee]

I could see adding something like this to a utils package in opaque keys, but it'd be nice if it worked across all key types instead of being course key specific.

Is it a requirement that the generated file names be human readable? Using base64.urlsafe_b64encode on the serialized key would give you something that's guaranteed to be robust and reversible -- in which case you might not need to add a new method at all.

Take care.

Dave

--
You received this message because you are subscribed to the Google Groups "General Open edX discussion" group.
To view this discussion on the web visit https://groups.google.com/d/msgid/edx-code/08b5861c-591d-412a-b1c3-9bb7ad4b4498%40googlegroups.com.

[Jill Vogel]

Hi David,

Even if we use something external like urlsafe_b64encode, I would still rather have a shared library that returns the officially sanctioned opaque-key safe filenames.

I've started an opaque-keys PR, but it just copies the existing functionality and tests.

Should I update that PR to handle any OpaqueKey?

And would you like me to use base64.urlsafe_b64encode, or is it ok to use the existing alphanumeric logic?

Thanks!

--

Jill

@OpenCraft

[Gabe Mulley]

I put this in slack as well, but we have at least one use case that require human-readable names.

Specifically: names of files in data packages exported to researchers.

We might be able to reconfigure things so that this is no longer necessary, but it would require some investigation to see how feasible that would be.

--

You received this message because you are subscribed to the Google Groups "General Open edX discussion" group.

To view this discussion on the web visit https://groups.google.com/d/msgid/edx-code/CAMZ1AtKwTOLwwJCNoU9mAGr_gXDaR__nYNRM_ppKhGr7undRPw%40mail.gmail.com.