Added support for global date formats and fixed drf date formats not supported

[rptmat57]

#49
Changes:

• added field dictionary to check field types more easily
• added global date format settings
• added support for rest framework date formats

This was a bit more complicated than I originally thought because the data is already formatted by drf, and because we needed to know the field type (couldn't rely on the type since it was a str).

I realized the current version would break when using drf's DATETIME_FORMAT, DATE_FORMAT or TIME_FORMAT because parse_datetime() and parse_date() could not parse non-iso formats.

Take a look and let me know what you think.

Also what should the settings be name and where should they be?
I went with DRF_RENDERER_XLSX_ prefix in global django settings:

• DRF_RENDERER_XLSX_DATETIME_FORMAT
• DRF_RENDERER_XLSX_DATE_FORMAT
• DRF_RENDERER_XLSX_TIME_FORMAT

Another option would be to stick these settings inside REST_FRAMEWORK = {} instead?

[FlipperPA]

@rptmat57 @willtho89 Thanks for the contribution! Before we review and merge this, I want to raise a question that's been on my mind.

Do we want to rename this package something less... obtuse? Like drf-excel or drf-spreadsheet? We could stub out the current name, and go with something easier. Thoughts?

That way, the prefix for settings could be DRF_EXCEL_ instead of DRF_RENDERER_XLSX_.

I'm not married to the current package name and figured we should have the conversation before we create global settings, to avoid headaches for people down the road.

[rptmat57]

That's probably a good time to have that discussion.
All I can say is I think it should start with drf- 😉

Jokes aside, the current name doesn't bother me. it's pretty explicit and does what it says.
Unless there is a plan to add support for more excel formats (xls?) or more spreadsheet formats (csv, gsheet, openoffice...)

Just my 2 cents.

[willtho89]

Current name also doesn't bother me, but I can see where you are coming from. Other Packages mostly use djangorestframework-{format}, so djangorestframework-xlsx. As far as I can see none of them use global settings though.

I would leave this up to you @FlipperPA

[willtho89]

lgtm

@rptmat57 when we decide on a name please also update README.md briefly explaining these settings

[rptmat57]

sure thing. I'll update the README

With regards to settings, what do you think about having them inside REST_FRAMEWORK?

[FlipperPA]

Let me bounce these questions off Tom Christie and a few others, since we're playing in that ecosystem. :) Great work, my friends.

If you want to follow on Twitter: https://twitter.com/FlipperPA/status/1493772563645927427

[willtho89]

Awesome work @rptmat57. Using cell formatting is a great feature generally.

I'm not sure how we handle breaking changes. Imo Deprecation warnings would be best. @FlipperPA what would you suggest?

[FlipperPA]

Deprecation warnings would be best - and I think we're probably around time for a 1.0 release and semver for breaking changes. I'll get us renamed to drf-spreadsheet today so that we can move forward with an easier name, and keep the old name as a stub. Thanks so much for both of your hard work on this!

[willtho89]

lgtm – aside from the new datetime formatting.

tested with some of our existing data/serializers. Had to rewrite the xlsx_date_format_mappings tough

[rptmat57]

would supporting both formats using a strftime_format property (or something similar) in the mapping dict be overkill?

[rptmat57]

Actually, nevermind. I would suggest that we could now use one format dictionary where both date and number formats could be defined. It would make things much easier. all following openpyxl formats

[rptmat57]

something like this:

format_mappings = {
    'created_at': 'yyyy-mm-dd h:mm:ss',
    'cost': '"$"#,##0.00_-',
}

[FlipperPA]

@rptmat57 @willtho89 Renaming is complete! I ended up going with drf-excel, since it is the only format we actually support.

You should be able to git remote set-url origin git@github.com:wharton/drf-excel.git and carry on. :)

[rptmat57]

should be done with changes now

[FlipperPA]

@rptmat57 This is looking really impressive. Thanks for putting so much effort in!

[rptmat57]

@FlipperPA thanks! I am hoping it will make dealing with formatting easier, and it will be very useful to me so it's a win-win.
Nice little plugin you guys put together

[rptmat57]

alright I am really done now. added styling/formatting per column

[FlipperPA]

@rptmat57 @willtho89 I'm good with merging this as long as you both are. Does this break backwards compatibility? Should this become released version 2.0.0?

We'll never get SemVer perfect, I'm sure, but should do our best. :)

[rptmat57]

it does break backwards compatibility with regards to date formats.
I am sorry I was trying to get the changes in before you release 1.0.0 but didn't realized it had already been released... my bad

[FlipperPA]

No biggie at all! I wanted the 1.0 release to be the name change, so 2.0 is just fine.

[LeeHanYeong]

When will version 2.0 with code written by rptmat57 be released? I was watching this conversation because I needed the number format function.

[FlipperPA]

@LeeHanYeong I'm going to get it out the door shortly. Today. :)

[rptmat57]

Nice, thanks!
I believe #4 and #30 can now be closed, since this is supported in 2.0.0

[FlipperPA]

Great work @rptmat57! Thanks so much, this is a major improvement. We are live!

https://pypi.org/project/drf-excel/2.0.0/