Fourniture de compatibilité descendante pour un composant Zope

Question

Je travaille sur une nouvelle version de collective.imagetags dans laquelle toutes les fonctionnalités qui ont été portées par une vue de navigateur (imagetags-manage) sont maintenant déplacées vers un nouvel adaptateur (pas encore engagé) qui fournit presque la même interface que la vue du navigateur ::

class IManageTags(Interface): 
    """ 
    imagetags-manage view interface 
    Tag management browser view 
    """ 

    def get_tag(id, create_on_fail=True): 
     """ Gets/creates a specific tag """ 

    def get_tags(): 
     """ Gets all the tags for the object """ 

    def get_sorted_tags(): 
     """ Sorted list of tags 
     """ 

    def save_tag(data): 
     """ Saves a tag with the passed data """ 

Je ne sais vraiment pas si quelqu'un utilise ce produit dans un projet, cependant, je pense que ce serait une idée raisonnable de prévoir un mécanisme de compatibilité ascendante, en Si quelqu'un utilise les méthodes d'affichage du navigateur en dehors des fonctionnalités prêtes à l'emploi.

Que dois-je faire? Conserver l'interface de la vue du navigateur avec les méthodes de remplacement qui relaient sur la nouvelle carte? Une suggestion?

Answer 1

Ce genre de changement est assez difficile! Ce n'est pas une question d'API mais de design.

• Les vues de navigateur sont un composant où vous mélangez utilisation/demande avec le contexte.
• Les adaptateurs sont des composants où vous ne vous souciez pas de l'utilisateur ou de sa requête.
• utilitaire sont des composants où vous ne vous souciez pas du contexte.

Donc, vous devriez garder votre navigateur et l'utiliser, il devrait être suffisant pour garder la compatibilité.

Les mises à niveau sont utilisées lorsque vous modifiez le profil par défaut. Tout d'abord la version metadata.xml doit être un entier (1000 est souvent utilisé comme première version stable) Ensuite, tous les changements au profil devraient suivre une augmentation de ce numéro de version et vous devez ajouter une étape de mise à niveau:

<gs:upgradeStep 
    title="Upgrade collective.myaddon from 1000 to 1010" 
    description="" 
    source="1000" 
    destination="1010" 
    handler=".upgrades.upgrade_1000_1010" 
    profile="collective.myaddon:default"/> 


upgrades.py 
def upgrade_1000_1010(context): 
    """documentation 
    """ 
    context.runImportStepFromProfile(default_profile, 'viewlets') 
    portal_javascripts = getToolByName(context, 'portal_javascripts') 
    portal_javascripts.cookResources()