bikeshedder / django-composite-field Goto Github PK

Django's Field implements __eq__ and __lt__, which allows fields to be sorted.

CompositeField also implements __eq__ and __lt__.
However, this does not guarantee that a list containing Fields and CompositeFields can be sorted.
This is because Field.__lt__ is only aware of Field but not CompositeField, which means Field() < CompositeField() returns NotImplemented.
To fix this issue, CompositeField needs to tell Python how to do Field() < CompositeField() by implementing __gt__.

Hi, I try to create a simple CompositeField:

class PeriodField(CompositeField)
    start=models.DateTimeField()
    end=models.DateTimeField()

and use it somewhere...

class MyModel(models.Model):
    period = PeriodField(help_text="fooo")

And it prints an error:

    period = PeriodField(
TypeError: __init__() got an unexpected keyword argument 'help_text'

I saw in your Changelog, that you seemed to implement this at some point of time, is that gone again?

can't I add help_text etc. to a composite field, like blank/null?

I noticed there are no tags on this repo for all releases to date, and there are zero issues, so I was curious whether this is still maintained or whether it was a good idea at the time that's no longer relevant/worked on.

I wanted to ask if there is some way how to pass options like verbose_name into the individual fields while using CompositeField.

Example usage:

class PrerenderedMarkdownxField(CompositeField):
    markdown = MarkdownxField()
    prerendered = TextField(null=True)

class TestModel(Model):
   markdown = PrerenderedMarkdownxField(markdown_verbose_name="Markdown Field")

This project should be converted to a poetry setup.
That would make it much easier to work on it and make releases.

The current solution is a Makefile so I don't forget the commands that need to be issued and the typical setup.py + setup.cfg mess.

Hey!

I'm trying to upgrade my project to Django 5 and I run into such an issue:

  File "/Users/jakubste/.virtualenvs/bdsm-S0d35qI4-py3.11/lib/python3.11/site-packages/django/db/models/base.py", line 511, in __init__
    if field.attname not in kwargs and field.column is None or field.generated:
                                                               ^^^^^^^^^^^^^^^
AttributeError: 'PartialDateField' object has no attribute 'generated'

PartialDateField is my class that uses CompositeField and it's quite simple:

class PartialDateField(CompositeField):
    year = models.IntegerField(null=True, blank=True)
    month = models.IntegerField(null=True, blank=True)
    day = models.IntegerField(null=True, blank=True)

Django 5 introduced generated fields and it looks like the fix is as easy as adding generated = False field in CompositeField.

Any chances for patching this? :)

I used to run the tests with tox and a lot of python versions installed directly on my Ubuntu machine via the deadsnakes PPA. The current GitHub action works exactly like that.

This is not very future proof and it would be great if the tests were run in parallel with a matrix in the GitHub workflow file rather than running all tests as part of a single command.

Using a CompositeField as the output_field in a (an outer) django.db.models.Func, such as within a call to qs.aggregate(), results in:

type object 'MyCompositeField' has no attribute 'get_internal_type'"

For example:

MyModel.objects.aggregate(
    min=Min(
        Func(F("a"), F("b"), function="construct_composite", output_field=MyCompositeField()),
    ),
)