Bon, je suis encore en retard pour la django app du mois de juillet, mais je m’am\u00e9liore, je n’ai plus que 20 jours de retard.<\/p>\n
Esp\u00e9rons que la django app du mois d’aout soit \u00e0 l’heure…. En attendant de voir si en ao\u00fbt, \u00e0 l’heure je serais, je vous propose de d\u00e9couvrir cette petite django-app bien sympatique.<\/p>\n
Mais avant un peu de contexte. Je cherche depuis quelques temps une django app pour faire de l’autocompletion. Djangopackages<\/a> qui est d\u00e9cid\u00e9ment tr\u00e8s souvent mon ami propose un tableau r\u00e9capitulatif assez sympa d’un certain nombre d’app qui propose cela<\/a>.<\/p>\n Parmi la liste, j’ai d\u00e9cid\u00e9 de tester django-autocomplete<\/a> qui me paraissait le mieux r\u00e9pondre \u00e0 mes besoin, \u00e0 savoir de l’autocomplete facile cot\u00e9 admin, comme cot\u00e9 site non admin.<\/p>\n Nouveaut\u00e9 ce mois si au niveau du billet, je vais vous pr\u00e9senter deux versions de l’app \u00e0 savoir la version ‘officielle’ faite par tyrion<\/a> et un fork fait par etienned<\/a>. Pourquoi vous pr\u00e9sentez deux versions ? Parce que la version d’etienned propose quelques am\u00e9liorations visuelles int\u00e9ressantes (et quelques petits refactor pas d\u00e9biles).<\/p>\n Ici cela d\u00e9pends de la version que vous d\u00e9sirez tester de django-autocomplete. Si vous voulez tester la version premi\u00e8re de tyrion<\/a> alors vous avez deux possibilit\u00e9 :<\/p>\n Par contre pour la version d’etienned<\/a>, pas de package, donc pas d’easy_install ou de pip, il n’y a qu’une solution, un bon vieux hg clone<\/p>\n Chose suffisamment rare pour qu’elle soit mis en avant, il y a une d\u00e9mo de la version premi\u00e8re, que vous pourrez tester ici<\/a>.<\/p>\n Concernant la doc, pour les deux versions, tout se trouve dans bitbucket.<\/p>\n Est ce que c’est suffisant ? Si vous envisagez de n’utiliser l’autocompl\u00e9tion que dans la partie admin, clairement oui. Sinon alors l\u00e0, clairement non. Vraiment pas m\u00eame. Et \u00e0 vous les joies de la lecture du code source pour comprendre comment cela fonctionne (ou alors vous pouvez continuer \u00e0 lire mon billet et voir comment tout cela fonctionne dans la partie 3 \ud83d\ude42 ).<\/p>\n Tout simplement \u00e0 proposer un m\u00e9canisme d’autocompl\u00e9tion sur les champs texte ou Int mais aussi les foreignkey et les manytomany. Et qui, cerise sur le g\u00e2teau, ce veut simple au niveau de son d\u00e9ploiement<\/p>\n Et \u00e0 le faire d’une fa\u00e7on un peu ‘magique’. On d\u00e9clare seulement quels sont les models qui mettront en place l’autocompl\u00e9tion et pour lesquels de leur champs. Et apr\u00e8s tout ce fait presque tout seul (en tout cas pour la mise en place des urls qui permettent de retourner le r\u00e9sultat du filtrage en fonction des caract\u00e8res tap\u00e9s, c’est tout automatique).<\/p>\n C’est presque tout simple. En tout cas si vous voulez int\u00e9grer django-autcomplete dans l’admin.<\/p>\n Imaginons que vous vouliez autocomplete les auteurs de bouquin dans une app de critique de livre.<\/p>\n Vous allez commencer par d\u00e9clarer une classe qui configure votre autocomplete :<\/p>\n Ensuite ?<\/p>\n Vous d\u00e9clarez simplement o\u00f9 vous voulez utiliser votre autocomplete. En partant du principe que votre model pour les reviews de bouquin s’appelle Reviews et que le champ pour l’autheur du bouquin s’appelle book_author cela donnera cela :<\/p>\n et voil\u00e0. C’est fini. Vous avez dans votre admin, un champ ForeignKey en autocompl\u00e9tion. Et sans forcer.<\/p>\n En lisant la doc vous verrez que l’on peut faire de fa\u00e7on diff\u00e9rente, sp\u00e9cifier le queryset sur lequel on veut limiter l’autocomplete, etc etc \u2026<\/p>\n Maintenant, qu’est ce qui se passe si vous voulez mettre un peu d’autocompl\u00e9tion dans votre site version pas admin ?<\/p>\n Hum ben l\u00e0, c’est pas beaucoup plus compliqu\u00e9 en fait. Le probl\u00e8me est juste qu’il n’existe pas de doc. Il vous suffit alors dans votre formulaire, de rajouter le param\u00eatre widget \u00e0 votre Field et de lui passer un AutocompleteWidget (qui a lui m\u00eame en param\u00e8tre le champ qui mettra en place l’autocompl\u00e9tion).<\/p>\n Si l’on reprend l’exemple d’au dessus on pourrait avoir quelque chose ressemblant \u00e0 cela :<\/p>\n Il y a bien \u00e9videment le widget qui va bien pour la version multiple s\u00e9lection (MultipleAutocompleteWidget)<\/p>\n Et si l’on continue \u00e0 fouiller un peu plus, dans utils, on trouvera une tr\u00e8s sympathique autocompleteform_factory qui permet de g\u00e9n\u00e9rer un form en prenant un param\u00e8tre le Model qui va bien, un dictionnaire listant les champs impl\u00e9mentant l’autocompl\u00e9tion J’ai eu quelques probl\u00e8mes lors de mes tests lorsque j’ai voulu installer django-autocomplete en temps qu’app dans le r\u00e9pertoire de mon projet et pas dans mon pythonpath. J’avais des ph\u00e9nom\u00e8nes bizarre de double ex\u00e9cution de code qui me donnais de jolies exception. Je n’ai pas vraiment r\u00e9ussi \u00e0 comprendre le pourquoi du comment ni pourquoi en sortant simplement l’app du r\u00e9pertoire de mon projet cela se mettait \u00e0 fonctionner parfaitement…<\/p>\n Pour ceux qui utilisent grappeli, je viens de voir qu’il existait un fork de django-autocomplete<\/a> pour en faciliter l’int\u00e9gration. Mais par contre, l\u00e0, je n’ai pas du tout essay\u00e9.<\/p>\n Ha et pour finir, le titre est une r\u00e9f\u00e9rence un peu obscure \u00e0 un film avec Jack Black:).<\/p>\n","protected":false},"excerpt":{"rendered":" Bon, je suis encore en retard pour la django app du mois de juillet, mais je m’am\u00e9liore, je n’ai plus que 20 jours de retard. Esp\u00e9rons que la django app du mois d’aout soit \u00e0 l’heure…. En attendant de voir si en ao\u00fbt, \u00e0 l’heure je serais, je vous propose de d\u00e9couvrir cette petite django-app … Continue reading Django-Autocomplete, and all your requests will be complete, but be careful with the horn<\/span><\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[35],"tags":[99,98],"class_list":["post-1598","post","type-post","status-publish","format-standard","hentry","category-la-django-app-du-mois","tag-django","tag-python"],"aioseo_notices":[],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p12cdp-pM","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/posts\/1598","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/comments?post=1598"}],"version-history":[{"count":9,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/posts\/1598\/revisions"}],"predecessor-version":[{"id":1690,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/posts\/1598\/revisions\/1690"}],"wp:attachment":[{"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/media?parent=1598"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/categories?post=1598"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/j-mad.com\/blog\/wp-json\/wp\/v2\/tags?post=1598"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}1- O\u00f9 on le trouve, comment on l\u2019installe, tout \u00e7a quoi (et la doc) ?<\/h1>\n
\n
\n
2- Mais au fait, \u00e0 quoi \u00e7a sert ?<\/h1>\n
3- Comment \u00e7a marche ?<\/h1>\n
\nclass<\/span> AuthorAutocomplete(<\/span>AutocompleteSettings)<\/span>:
\nsearch_fields =<\/span> (<\/span>'^first_name'<\/span>,<\/span>'^last_name'<\/span>)<\/span><\/div><\/div>\n
\nautocomplete.register<\/span>(<\/span>Reviews.book_author<\/span>,<\/span> AuthorAutocomplete)<\/span><\/div><\/div>\n
\nMais si vous farfouillez dans le code vous verrez qu’il existe une classe de widget (AutocompleteWidget qui se trouve dans autocomplete.widgets qui permet de mettre en place l’autocompl\u00e9tion).<\/p>\n
\nauthor =<\/span> forms.ChoiceField<\/span>(<\/span>widget=<\/span>AutocompleteWidget(<\/span>Review.book_author<\/span> )<\/span>)<\/span><\/div><\/div>\n
\nainsi que les champs \u00e0 exclure.<\/p>\n4 conclusion et tips.<\/h1>\n