8000 Improve html table rendering formatting · Issue #1078 · apache/datafusion-python · GitHub
[go: up one dir, main page]
Skip to content

Improve html table rendering formatting #1078

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.

Sign up for GitHub

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

Jump to bottom
Closed
timsaucer opened this issue Mar 22, 2025 · 2 comments
Closed

Improve html table rendering formatting #1078

timsaucer opened this issue Mar 22, 2025 · 2 comments
Labels
enhancement New feature or request

Comments

@timsaucer
Copy link
Contributor

Is your feature request related to a problem or challenge? Please describe what you are trying to do.

This is a follow on to #1036

There is a suggestion that we should enable a feature to customize the html table rendering.

Describe the solution you'd like

Allow the user to set the amount of data returned. Right now it's hard coded to 2 MB. The actual data size is approximated. We would like this to be customizable.

Allow the user to disable the styling that is applied to the html output.

Optional: Add a way for a user to specify a formatting function to replace the default ArrayFormatter. This would enable users to change the data view when they have custom metadata

Nice to have: Split up some of the html generation into a set of helper functions.

Describe alternatives you've considered

None

Additional context

If this code is getting too large, it may make sense to split it off into a separate file.
@timsaucer timsaucer added the enhancement New feature or request label Mar 22, 2025
@timsaucer timsaucer mentioned this issue Mar 22, 2025
Merged
This was referenced Mar 28, 2025
Closed
Closed
@AgalyaS1757
Copy link
AgalyaS1757 commented Apr 1, 2025 •
edited
Loading

Solution Are; #1036

  1. Modify the Data Size Limit
    Identify the part of the code where the 2MB limit is enforced.

Introduce a user-configurable parameter (e.g., max_data_size), allowing users to set their preferred limit.

Ensure that the size approximation logic remains efficient and does not slow down performance.

  1. Add an Option to Disable Styling
    Locate the existing HTML rendering logic where styles are applied.

Introduce a flag (e.g., disable_styling) that allows users to enable or disable CSS styling in the output.

Implement a conditional check to apply styling only if the flag is not set.

  1. Enable Custom Formatting
    Modify the ArrayFormatter or introduce a parameter (e.g., custom_formatter) that allows users to pass their own formatting function.

Ensure that the custom function is validated and safely applied without breaking existing functionality.

  1. Refactor HTML Generation Code (Nice-to-have for maintainability)
    Break down the existing monolithic HTML rendering function into smaller, reusable helper functions.

Consider moving the HTML-related functions into a separate module/file if the changes become too extensive.

  1. Testing & Documentation
    Write test cases to ensure the new functionalities work as expected.

Update the documentation with clear examples on how to:

Set a custom data size limit.

Disable styling.

Use a custom formatter.

@kosiew kosiew mentioned this issue Apr 28, 2025
Merged
@timsaucer
Copy link
Contributor Author

Closed due to the excellent work by @kosiew

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Partial fix for #1078 — [Add Dataframe display config] kosiew/datafusion-python
2 participants
@timsaucer @AgalyaS1757
0