Split (1)

train · 69.7k rows

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.

in_source_id stringlengths 13 58	issue stringlengths 3 241k	before_files listlengths 0 3	after_files listlengths 0 3	pr_diff stringlengths 109 107M ⌀
genialis__resolwe-167	Ordering of processes does not work Tested on the QA server: https://qa.genialis.com/api/process?slug=alignment-bwa-mem&ordering=-version For the above query, the `alignment-bwa-mem` processes should be sorted by version, descending. The version 16777232 should be at the top, but comes second.	[ { "content": "\"\"\".. Ignore pydocstyle D400.\n\n==========\nFlow Views\n==========\n\n\"\"\"\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nimport pkgutil\nfrom importlib import import_module\n\nfrom django.db import IntegrityError, transaction\nfrom django.db.models.query import Prefetch\nfrom django.conf import settings\nfrom django.contrib.auth import get_user_model\nfrom django.contrib.auth.models import AnonymousUser, Group, Permission\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ImproperlyConfigured\nfrom django.utils._os import upath\n\n\nfrom rest_framework import exceptions, mixins, viewsets, status\nfrom rest_framework.decorators import detail_route, list_route\nfrom rest_framework.response import Response\n\nfrom guardian import shortcuts\n\nfrom resolwe.flow.models import dict_dot, iterate_schema\nfrom resolwe.flow.utils import get_data_checksum\nfrom resolwe.permissions.shortcuts import get_object_perms, get_objects_for_user\n\nfrom .filters import DataFilter, CollectionFilter, ProcessFilter\nfrom .managers import manager\nfrom .models import Collection, Process, Data, DescriptorSchema, Trigger, Storage\nfrom .serializers import (CollectionSerializer, ProcessSerializer, DataSerializer,\n DescriptorSchemaSerializer, TriggerSerializer, StorageSerializer)\n\n\ndef assign_perm(args, kwargs):\n \"\"\"Wrapper for assign_perm function.\n\n Call original assign_perms function from django-guardian, but don't\n raise exception if permission is not found\n\n \"\"\"\n try:\n shortcuts.assign_perm(args, *kwargs)\n except Permission.DoesNotExist:\n pass\n\n\ndef remove_perm(args, *kwargs):\n \"\"\"Wrapper for remove_perm function.\n\n Call original remove_perms function from django-guardian, but don't\n raise exception if permission is not found\n\n \"\"\"\n try:\n shortcuts.remove_perm(args, *kwargs)\n except Permission.DoesNotExist:\n pass\n\n\ndef load_permissions(permissions_name):\n \"\"\"Look for a fully qualified flow permissions class.\"\"\"\n try:\n return import_module('{}'.format(permissions_name)).ResolwePermissions\n except AttributeError:\n raise AttributeError(\"'ResolwePermissions' class not found in {} module.\".format(\n permissions_name))\n except ImportError as ex:\n # The permissions module wasn't found. Display a helpful error\n # message listing all possible (built-in) permissions classes.\n permissions_dir = os.path.join(os.path.dirname(upath(__file__)), '..', 'perms')\n permissions_dir = os.path.normpath(permissions_dir)\n\n try:\n builtin_permissions = [\n name for _, name, _ in pkgutil.iter_modules([permissions_dir]) if name not in [u'tests']]\n except EnvironmentError:\n builtin_permissions = []\n if permissions_name not in ['resolwe.auth.{}'.format(p) for p in builtin_permissions]:\n permissions_reprs = map(repr, sorted(builtin_permissions))\n err_msg = (\"{} isn't an available flow permissions class.\\n\"\n \"Try using 'resolwe.auth.XXX', where XXX is one of:\\n\"\n \" {}\\n\"\n \"Error was: {}\".format(permissions_name, \", \".join(permissions_reprs), ex))\n raise ImproperlyConfigured(err_msg)\n else:\n # If there's some other error, this must be an error in Django\n raise\n\n\npermissions_cls = load_permissions(settings.FLOW_API['PERMISSIONS']) # pylint: disable=invalid-name\n\n\nclass ResolweCreateModelMixin(mixins.CreateModelMixin):\n \"\"\"Mixin to support creating new `Resolwe` models.\n\n Extends `django_rest_framework`'s class `CreateModelMixin` with:\n\n append user's id from request to posted data as `contributor`\n key\n * catch `IntegrityError`s, so we can return HTTP status 409\n instead of raising error\n\n \"\"\"\n\n def create(self, request, args, kwargs):\n \"\"\"Create a resource.\"\"\"\n user = request.user\n if not user.is_authenticated():\n raise exceptions.NotFound\n\n ds_slug = request.data.get('descriptor_schema', None)\n if ds_slug:\n ds_query = DescriptorSchema.objects.filter(slug=ds_slug).order_by('version')\n if not ds_query.exists():\n return Response(\n {'descriptor_schema': [\n 'Invalid descriptor_schema slug \"{}\" - object does not exist.'.format(ds_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n request.data['descriptor_schema'] = ds_query.last().pk\n\n request.data['contributor'] = user.pk\n try:\n return super(ResolweCreateModelMixin, self).create(request, args, *kwargs)\n\n except IntegrityError as ex:\n return Response({u'error': str(ex)}, status=status.HTTP_409_CONFLICT)\n\n def perform_create(self, serializer):\n \"\"\"Create a resource.\"\"\"\n with transaction.atomic():\n instance = serializer.save()\n\n # Assign all permissions to the object contributor.\n for permission in list(zip(instance._meta.permissions))[0]: # pylint: disable=protected-access\n assign_perm(permission, instance.contributor, instance)\n\n\nclass ResolweUpdateModelMixin(mixins.UpdateModelMixin):\n \"\"\"Mixin to support updating `Resolwe` models.\n\n Extends `django_rest_framework`'s class `UpdateModelMixin` with:\n\n * translate `descriptor_schema` field from DescriptorSchema's\n slug to its id and return 400 error Response if it doesn't\n exists\n\n \"\"\"\n\n def update(self, request, args, kwargs):\n \"\"\"Update a resource.\"\"\"\n ds_slug = request.data.get('descriptor_schema', None)\n if ds_slug:\n ds_query = DescriptorSchema.objects.filter(slug=ds_slug).order_by('version')\n if not ds_query.exists():\n return Response(\n {'descriptor_schema': [\n 'Invalid descriptor_schema slug \"{}\" - object does not exist.'.format(ds_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n request.data['descriptor_schema'] = ds_query.last().pk\n\n return super(ResolweUpdateModelMixin, self).update(request, args, *kwargs)\n\n\nclass ResolweCreateDataModelMixin(ResolweCreateModelMixin):\n \"\"\"Mixin to support creating new :class:`Data` objects.\n\n Extends :class:`ResolweCcreateModelMixin` with:\n\n checks if there is exactly 1 collection listed on create\n * checks if user has `add` permission on that collection\n\n \"\"\"\n\n def create(self, request, args, kwargs):\n \"\"\"Create a resource.\"\"\"\n collections = request.data.get('collections', [])\n\n # check that user has permissions on all collections that Data\n # object will be added to\n for collection_id in collections:\n try:\n collection = Collection.objects.get(pk=collection_id)\n except Collection.DoesNotExist:\n return Response({'collections': ['Invalid pk \"{}\" - object does not exist.'.format(collection_id)]},\n status=status.HTTP_400_BAD_REQUEST)\n\n if not request.user.has_perm('add_collection', obj=collection):\n if request.user.is_authenticated():\n raise exceptions.PermissionDenied\n else:\n raise exceptions.NotFound\n\n # translate processe's slug to id\n process_slug = request.data.get('process', None)\n process_query = Process.objects.filter(slug=process_slug).order_by('version')\n if not process_query.exists():\n # XXX: security - is it ok to reveal which processes (don't) exist?\n return Response({'process': ['Invalid process slug \"{}\" - object does not exist.'.format(process_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n process = process_query.last()\n request.data['process'] = process.pk\n\n # check that user has permission on the process\n if not request.user.has_perm('view_process', obj=process):\n if request.user.is_authenticated():\n raise exceptions.PermissionDenied\n else:\n raise exceptions.NotFound\n\n # perform \"get_or_create\" if requested - return existing object\n # if found\n if kwargs.pop('get_or_create', False):\n process_input = request.data.get('input', {})\n\n # use default values if they are not given\n for field_schema, fields, path in iterate_schema(process_input, process.input_schema):\n if 'default' in field_schema and field_schema['name'] not in fields:\n dict_dot(process_input, path, field_schema['default'])\n\n checksum = get_data_checksum(process_input, process.slug, process.version)\n data_qs = Data.objects.filter(\n checksum=checksum,\n process__persistence__in=[Process.PERSISTENCE_CACHED, Process.PERSISTENCE_TEMP],\n )\n data_qs = get_objects_for_user(request.user, 'view_data', data_qs)\n if data_qs.exists():\n data = data_qs.order_by('created').last()\n serializer = self.get_serializer(data)\n return Response(serializer.data)\n\n # create the objects\n resp = super(ResolweCreateDataModelMixin, self).create(request, args, *kwargs)\n\n # run manager\n manager.communicate()\n\n return resp\n\n @list_route(methods=[u'post'])\n def get_or_create(self, request, args, *kwargs):\n \"\"\"Get ``Data`` object if similar already exists, otherwise create it.\"\"\"\n kwargs['get_or_create'] = True\n return self.create(request, args, *kwargs)\n\n def perform_create(self, serializer):\n \"\"\"Create a resource.\"\"\"\n with transaction.atomic():\n instance = serializer.save()\n\n # Assign all permissions to the object contributor.\n for permission in list(zip(instance._meta.permissions))[0]: # pylint: disable=protected-access\n assign_perm(permission, instance.contributor, instance)\n\n collections = self.request.data.get('collections', [])\n for c in collections:\n collection = Collection.objects.get(pk=c)\n collection.data.add(instance)\n\n\nclass ResolwePermissionsMixin(object):\n \"\"\"Mixin to support managing `Resolwe` objects' permissions.\"\"\"\n\n def _fetch_user(self, query):\n \"\"\"Get user by ``pk`` or ``username``. Return ``None`` if doesn't exist.\"\"\"\n user_model = get_user_model()\n\n user_filter = {'pk': query} if query.isdigit() else {'username': query}\n try:\n return user_model.objects.get(user_filter)\n except user_model.DoesNotExist:\n raise exceptions.ParseError(\"User ({}) does not exists.\".format(user_filter))\n\n def _fetch_group(self, query):\n \"\"\"Get group by ``pk`` or ``name``. Return ``None`` if doesn't exist.\"\"\"\n group_filter = {'pk': query} if query.isdigit() else {'name': query}\n try:\n return Group.objects.get(group_filter)\n except Group.DoesNotExist:\n raise exceptions.ParseError(\"Group ({}) does not exists.\".format(group_filter))\n\n def _update_permission(self, obj, data):\n \"\"\"Update object permissions.\"\"\"\n content_type = ContentType.objects.get_for_model(obj)\n full_permissions = list(zip(*obj._meta.permissions))[0] # pylint: disable=protected-access\n\n def set_permissions(entity_type, perm_type):\n \"\"\"Set object permissions.\"\"\"\n perm_func = assign_perm if perm_type == 'add' else remove_perm\n fetch = self._fetch_user if entity_type == 'users' else self._fetch_group\n\n for entity_id in data.get(entity_type, {}).get(perm_type, []):\n entity = fetch(entity_id)\n if entity:\n perms = data[entity_type][perm_type][entity_id]\n if perms == u'ALL':\n perms = full_permissions\n for perm in perms:\n perm_func('{}_{}'.format(perm.lower(), content_type), entity, obj)\n\n set_permissions('users', 'add')\n set_permissions('users', 'remove')\n set_permissions('groups', 'add')\n set_permissions('groups', 'remove')\n\n def set_public_permissions(perm_type):\n \"\"\"Set public permissions.\"\"\"\n perm_func = assign_perm if perm_type == 'add' else remove_perm\n user = AnonymousUser()\n perms = data.get('public', {}).get(perm_type, [])\n if perms == u'ALL':\n perms = full_permissions\n for perm in perms:\n perm_func('{}_{}'.format(perm.lower(), content_type), user, obj)\n\n set_public_permissions('add')\n set_public_permissions('remove')\n\n def get_serializer_class(self):\n \"\"\"Augment base serializer class.\n\n Include permissions information with objects.\n\n \"\"\"\n base_class = super(ResolwePermissionsMixin, self).get_serializer_class()\n\n class SerializerWithPermissions(base_class):\n \"\"\"Augment serializer class.\"\"\"\n\n def to_representation(serializer_self, instance): # pylint: disable=no-self-argument\n \"\"\"Object serializer.\"\"\"\n # TODO: These permissions queries may be expensive. Should we limit or optimize this?\n data = super(SerializerWithPermissions, serializer_self).to_representation(instance)\n data['permissions'] = get_object_perms(instance, self.request.user)\n return data\n\n return SerializerWithPermissions\n\n def _filter_owner_permission(self, data):\n \"\"\"Raise ``PermissionDenied``if ``owner`` found in ``data``.\"\"\"\n for entity_type in ['users', 'groups']:\n if entity_type in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data[entity_type]:\n for entity_id in data[entity_type][perm_type]:\n for perm in data[entity_type][perm_type][entity_id]:\n if perm == 'owner':\n raise exceptions.PermissionDenied(\"Only owners can grant/revoke owner permission\")\n\n def _filter_public_permissions(self, data):\n \"\"\"Raise ``PermissionDenied`` if public permissions are too open.\"\"\"\n allowed_public_permissions = ['view', 'add', 'download']\n\n if 'public' in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data['public']:\n for perm in data['public'][perm_type]:\n if perm not in allowed_public_permissions:\n raise exceptions.PermissionDenied(\"Permissions for public users are too open\")\n\n def _filter_user_permissions(self, data, user_pk):\n \"\"\"Raise ``PermissionDenied`` if ``data`` includes ``user_pk``.\"\"\"\n if 'users' in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data['users']:\n if user_pk in data['users'][perm_type].keys():\n raise exceptions.PermissionDenied(\"You cannot change your own permissions\")\n\n @detail_route(methods=['get', 'post'], url_path='permissions')\n def detail_permissions(self, request, pk=None):\n \"\"\"API endpoint to get/set permissions.\"\"\"\n obj = self.get_object()\n\n if request.method == 'POST':\n content_type = ContentType.objects.get_for_model(obj)\n\n owner_perm = 'owner_{}'.format(content_type)\n if not (request.user.has_perm(owner_perm, obj=obj) or request.user.is_superuser):\n self._filter_owner_permission(request.data)\n self._filter_public_permissions(request.data)\n self._filter_user_permissions(request.data, request.user.pk)\n\n self._update_permission(obj, request.data)\n\n return Response(get_object_perms(obj))\n\n @list_route(methods=['get', 'post'], url_path='permissions')\n def list_permissions(self, request):\n \"\"\"API endpoint to batch get/set permissions.\"\"\"\n # TODO: Implement batch get/set permissions\n return Response(status=status.HTTP_501_NOT_IMPLEMENTED)\n\n\nclass ResolweProcessPermissionsMixin(ResolwePermissionsMixin):\n \"\"\"Process permissions mixin.\"\"\"\n\n def _update_permission(self, obj, data):\n \"\"\"Update collection permissions.\"\"\"\n super(ResolweProcessPermissionsMixin, self)._update_permission(obj, data)\n\n if 'collections' in data:\n if 'add' in data['collections']:\n for _id in data['collections']['add']:\n try:\n Collection.objects.get(pk=_id).public_processes.add(obj)\n except Collection.DoesNotExist:\n pass\n if 'remove' in data['collections']:\n for _id in data['collections']['remove']:\n try:\n Collection.objects.get(pk=_id).public_processes.remove(obj)\n except Collection.DoesNotExist:\n pass\n\n\nclass ResolweCheckSlugMixin(object):\n \"\"\"Slug validation.\"\"\"\n\n @list_route(methods=[u'get'])\n def slug_exists(self, request):\n \"\"\"Check if given url slug exists.\n\n Check if slug given in query parameter ``name`` exists. Return\n ``True`` if slug already exists and ``False`` otherwise.\n\n \"\"\"\n if not request.user.is_authenticated():\n return Response(status=status.HTTP_401_UNAUTHORIZED)\n\n if 'name' not in request.query_params:\n return Response({'error': 'Query parameter `name` must be given.'},\n status=status.HTTP_400_BAD_REQUEST)\n\n queryset = self.get_queryset()\n slug_name = request.query_params['name']\n return Response(queryset.filter(slug__iexact=slug_name).exists())\n\n\nclass CollectionViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n ResolweUpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Collection` objects.\"\"\"\n\n queryset = Collection.objects.all().prefetch_related(\n 'descriptor_schema',\n 'contributor',\n Prefetch('data', queryset=Data.objects.all().order_by('id'))\n )\n serializer_class = CollectionSerializer\n permission_classes = (permissions_cls,)\n filter_class = CollectionFilter\n ordering_fields = ('id', 'created', 'modified', 'name')\n ordering = ('id',)\n\n @detail_route(methods=[u'post'])\n def add_data(self, request, pk=None):\n \"\"\"Add data to collection.\"\"\"\n collection = self.get_object()\n\n if 'ids' not in request.data:\n return Response({\"error\": \"`ids`parameter is required\"}, status=status.HTTP_400_BAD_REQUEST)\n\n missing = []\n for data_id in request.data['ids']:\n if not Data.objects.filter(pk=data_id).exists():\n missing.append(data_id)\n\n if missing:\n return Response(\n {\"error\": \"Data objects with following ids are missing: {}\".format(', '.join(missing))},\n status=status.HTTP_400_BAD_REQUEST)\n\n for data_id in request.data['ids']:\n collection.data.add(data_id)\n\n return Response()\n\n @detail_route(methods=[u'post'])\n def remove_data(self, request, pk=None):\n \"\"\"Remove data from collection.\"\"\"\n collection = self.get_object()\n\n if 'ids' not in request.data:\n return Response({\"error\": \"`ids`parameter is required\"}, status=status.HTTP_400_BAD_REQUEST)\n\n for data_id in request.data['ids']:\n collection.data.remove(data_id)\n\n return Response()\n\n\nclass ProcessViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n ResolweProcessPermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Process` objects.\"\"\"\n\n queryset = Process.objects.all().prefetch_related('contributor')\n serializer_class = ProcessSerializer\n permission_classes = (permissions_cls,)\n filter_class = ProcessFilter\n ordering_fields = ('id', 'created', 'modified', 'name')\n ordering = ('id',)\n\n\nclass DataViewSet(ResolweCreateDataModelMixin,\n mixins.RetrieveModelMixin,\n ResolweUpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Data` objects.\"\"\"\n\n queryset = Data.objects.all().prefetch_related('process', 'descriptor_schema', 'contributor')\n serializer_class = DataSerializer\n permission_classes = (permissions_cls,)\n filter_class = DataFilter\n ordering_fields = ('id', 'created', 'modified', 'started', 'finished', 'name')\n ordering = ('id',)\n\n\nclass DescriptorSchemaViewSet(mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`DescriptorSchema` objects.\"\"\"\n\n queryset = DescriptorSchema.objects.all().prefetch_related('contributor')\n serializer_class = DescriptorSchemaSerializer\n permission_classes = (permissions_cls,)\n filter_fields = ('contributor', 'name', 'description', 'created', 'modified', 'slug')\n ordering_fields = ('id', 'created', 'modified', 'name')\n ordering = ('id',)\n\n\nclass TriggerViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n mixins.UpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Trigger` objects.\"\"\"\n\n queryset = Trigger.objects.all().prefetch_related('contributor')\n serializer_class = TriggerSerializer\n permission_classes = (permissions_cls,)\n filter_fields = ('contributor', 'name', 'created', 'modified', 'slug', 'collection')\n\n\nclass StorageViewSet(mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Storage` objects.\"\"\"\n\n queryset = Storage.objects.all().prefetch_related('contributor')\n serializer_class = StorageSerializer\n filter_fields = ('contributor', 'name', 'created', 'modified', 'slug')\n", "path": "resolwe/flow/views.py" } ]	[ { "content": "\"\"\".. Ignore pydocstyle D400.\n\n==========\nFlow Views\n==========\n\n\"\"\"\nfrom __future__ import absolute_import, division, print_function, unicode_literals\n\nimport os\nimport pkgutil\nfrom importlib import import_module\n\nfrom django.db import IntegrityError, transaction\nfrom django.db.models.query import Prefetch\nfrom django.conf import settings\nfrom django.contrib.auth import get_user_model\nfrom django.contrib.auth.models import AnonymousUser, Group, Permission\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ImproperlyConfigured\nfrom django.utils._os import upath\n\n\nfrom rest_framework import exceptions, mixins, viewsets, status\nfrom rest_framework.decorators import detail_route, list_route\nfrom rest_framework.response import Response\n\nfrom guardian import shortcuts\n\nfrom resolwe.flow.models import dict_dot, iterate_schema\nfrom resolwe.flow.utils import get_data_checksum\nfrom resolwe.permissions.shortcuts import get_object_perms, get_objects_for_user\n\nfrom .filters import DataFilter, CollectionFilter, ProcessFilter\nfrom .managers import manager\nfrom .models import Collection, Process, Data, DescriptorSchema, Trigger, Storage\nfrom .serializers import (CollectionSerializer, ProcessSerializer, DataSerializer,\n DescriptorSchemaSerializer, TriggerSerializer, StorageSerializer)\n\n\ndef assign_perm(args, kwargs):\n \"\"\"Wrapper for assign_perm function.\n\n Call original assign_perms function from django-guardian, but don't\n raise exception if permission is not found\n\n \"\"\"\n try:\n shortcuts.assign_perm(args, *kwargs)\n except Permission.DoesNotExist:\n pass\n\n\ndef remove_perm(args, *kwargs):\n \"\"\"Wrapper for remove_perm function.\n\n Call original remove_perms function from django-guardian, but don't\n raise exception if permission is not found\n\n \"\"\"\n try:\n shortcuts.remove_perm(args, *kwargs)\n except Permission.DoesNotExist:\n pass\n\n\ndef load_permissions(permissions_name):\n \"\"\"Look for a fully qualified flow permissions class.\"\"\"\n try:\n return import_module('{}'.format(permissions_name)).ResolwePermissions\n except AttributeError:\n raise AttributeError(\"'ResolwePermissions' class not found in {} module.\".format(\n permissions_name))\n except ImportError as ex:\n # The permissions module wasn't found. Display a helpful error\n # message listing all possible (built-in) permissions classes.\n permissions_dir = os.path.join(os.path.dirname(upath(__file__)), '..', 'perms')\n permissions_dir = os.path.normpath(permissions_dir)\n\n try:\n builtin_permissions = [\n name for _, name, _ in pkgutil.iter_modules([permissions_dir]) if name not in [u'tests']]\n except EnvironmentError:\n builtin_permissions = []\n if permissions_name not in ['resolwe.auth.{}'.format(p) for p in builtin_permissions]:\n permissions_reprs = map(repr, sorted(builtin_permissions))\n err_msg = (\"{} isn't an available flow permissions class.\\n\"\n \"Try using 'resolwe.auth.XXX', where XXX is one of:\\n\"\n \" {}\\n\"\n \"Error was: {}\".format(permissions_name, \", \".join(permissions_reprs), ex))\n raise ImproperlyConfigured(err_msg)\n else:\n # If there's some other error, this must be an error in Django\n raise\n\n\npermissions_cls = load_permissions(settings.FLOW_API['PERMISSIONS']) # pylint: disable=invalid-name\n\n\nclass ResolweCreateModelMixin(mixins.CreateModelMixin):\n \"\"\"Mixin to support creating new `Resolwe` models.\n\n Extends `django_rest_framework`'s class `CreateModelMixin` with:\n\n append user's id from request to posted data as `contributor`\n key\n * catch `IntegrityError`s, so we can return HTTP status 409\n instead of raising error\n\n \"\"\"\n\n def create(self, request, args, kwargs):\n \"\"\"Create a resource.\"\"\"\n user = request.user\n if not user.is_authenticated():\n raise exceptions.NotFound\n\n ds_slug = request.data.get('descriptor_schema', None)\n if ds_slug:\n ds_query = DescriptorSchema.objects.filter(slug=ds_slug).order_by('version')\n if not ds_query.exists():\n return Response(\n {'descriptor_schema': [\n 'Invalid descriptor_schema slug \"{}\" - object does not exist.'.format(ds_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n request.data['descriptor_schema'] = ds_query.last().pk\n\n request.data['contributor'] = user.pk\n try:\n return super(ResolweCreateModelMixin, self).create(request, args, *kwargs)\n\n except IntegrityError as ex:\n return Response({u'error': str(ex)}, status=status.HTTP_409_CONFLICT)\n\n def perform_create(self, serializer):\n \"\"\"Create a resource.\"\"\"\n with transaction.atomic():\n instance = serializer.save()\n\n # Assign all permissions to the object contributor.\n for permission in list(zip(instance._meta.permissions))[0]: # pylint: disable=protected-access\n assign_perm(permission, instance.contributor, instance)\n\n\nclass ResolweUpdateModelMixin(mixins.UpdateModelMixin):\n \"\"\"Mixin to support updating `Resolwe` models.\n\n Extends `django_rest_framework`'s class `UpdateModelMixin` with:\n\n * translate `descriptor_schema` field from DescriptorSchema's\n slug to its id and return 400 error Response if it doesn't\n exists\n\n \"\"\"\n\n def update(self, request, args, kwargs):\n \"\"\"Update a resource.\"\"\"\n ds_slug = request.data.get('descriptor_schema', None)\n if ds_slug:\n ds_query = DescriptorSchema.objects.filter(slug=ds_slug).order_by('version')\n if not ds_query.exists():\n return Response(\n {'descriptor_schema': [\n 'Invalid descriptor_schema slug \"{}\" - object does not exist.'.format(ds_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n request.data['descriptor_schema'] = ds_query.last().pk\n\n return super(ResolweUpdateModelMixin, self).update(request, args, *kwargs)\n\n\nclass ResolweCreateDataModelMixin(ResolweCreateModelMixin):\n \"\"\"Mixin to support creating new :class:`Data` objects.\n\n Extends :class:`ResolweCcreateModelMixin` with:\n\n checks if there is exactly 1 collection listed on create\n * checks if user has `add` permission on that collection\n\n \"\"\"\n\n def create(self, request, args, kwargs):\n \"\"\"Create a resource.\"\"\"\n collections = request.data.get('collections', [])\n\n # check that user has permissions on all collections that Data\n # object will be added to\n for collection_id in collections:\n try:\n collection = Collection.objects.get(pk=collection_id)\n except Collection.DoesNotExist:\n return Response({'collections': ['Invalid pk \"{}\" - object does not exist.'.format(collection_id)]},\n status=status.HTTP_400_BAD_REQUEST)\n\n if not request.user.has_perm('add_collection', obj=collection):\n if request.user.is_authenticated():\n raise exceptions.PermissionDenied\n else:\n raise exceptions.NotFound\n\n # translate processe's slug to id\n process_slug = request.data.get('process', None)\n process_query = Process.objects.filter(slug=process_slug).order_by('version')\n if not process_query.exists():\n # XXX: security - is it ok to reveal which processes (don't) exist?\n return Response({'process': ['Invalid process slug \"{}\" - object does not exist.'.format(process_slug)]},\n status=status.HTTP_400_BAD_REQUEST)\n process = process_query.last()\n request.data['process'] = process.pk\n\n # check that user has permission on the process\n if not request.user.has_perm('view_process', obj=process):\n if request.user.is_authenticated():\n raise exceptions.PermissionDenied\n else:\n raise exceptions.NotFound\n\n # perform \"get_or_create\" if requested - return existing object\n # if found\n if kwargs.pop('get_or_create', False):\n process_input = request.data.get('input', {})\n\n # use default values if they are not given\n for field_schema, fields, path in iterate_schema(process_input, process.input_schema):\n if 'default' in field_schema and field_schema['name'] not in fields:\n dict_dot(process_input, path, field_schema['default'])\n\n checksum = get_data_checksum(process_input, process.slug, process.version)\n data_qs = Data.objects.filter(\n checksum=checksum,\n process__persistence__in=[Process.PERSISTENCE_CACHED, Process.PERSISTENCE_TEMP],\n )\n data_qs = get_objects_for_user(request.user, 'view_data', data_qs)\n if data_qs.exists():\n data = data_qs.order_by('created').last()\n serializer = self.get_serializer(data)\n return Response(serializer.data)\n\n # create the objects\n resp = super(ResolweCreateDataModelMixin, self).create(request, args, *kwargs)\n\n # run manager\n manager.communicate()\n\n return resp\n\n @list_route(methods=[u'post'])\n def get_or_create(self, request, args, *kwargs):\n \"\"\"Get ``Data`` object if similar already exists, otherwise create it.\"\"\"\n kwargs['get_or_create'] = True\n return self.create(request, args, *kwargs)\n\n def perform_create(self, serializer):\n \"\"\"Create a resource.\"\"\"\n with transaction.atomic():\n instance = serializer.save()\n\n # Assign all permissions to the object contributor.\n for permission in list(zip(instance._meta.permissions))[0]: # pylint: disable=protected-access\n assign_perm(permission, instance.contributor, instance)\n\n collections = self.request.data.get('collections', [])\n for c in collections:\n collection = Collection.objects.get(pk=c)\n collection.data.add(instance)\n\n\nclass ResolwePermissionsMixin(object):\n \"\"\"Mixin to support managing `Resolwe` objects' permissions.\"\"\"\n\n def _fetch_user(self, query):\n \"\"\"Get user by ``pk`` or ``username``. Return ``None`` if doesn't exist.\"\"\"\n user_model = get_user_model()\n\n user_filter = {'pk': query} if query.isdigit() else {'username': query}\n try:\n return user_model.objects.get(user_filter)\n except user_model.DoesNotExist:\n raise exceptions.ParseError(\"User ({}) does not exists.\".format(user_filter))\n\n def _fetch_group(self, query):\n \"\"\"Get group by ``pk`` or ``name``. Return ``None`` if doesn't exist.\"\"\"\n group_filter = {'pk': query} if query.isdigit() else {'name': query}\n try:\n return Group.objects.get(group_filter)\n except Group.DoesNotExist:\n raise exceptions.ParseError(\"Group ({}) does not exists.\".format(group_filter))\n\n def _update_permission(self, obj, data):\n \"\"\"Update object permissions.\"\"\"\n content_type = ContentType.objects.get_for_model(obj)\n full_permissions = list(zip(*obj._meta.permissions))[0] # pylint: disable=protected-access\n\n def set_permissions(entity_type, perm_type):\n \"\"\"Set object permissions.\"\"\"\n perm_func = assign_perm if perm_type == 'add' else remove_perm\n fetch = self._fetch_user if entity_type == 'users' else self._fetch_group\n\n for entity_id in data.get(entity_type, {}).get(perm_type, []):\n entity = fetch(entity_id)\n if entity:\n perms = data[entity_type][perm_type][entity_id]\n if perms == u'ALL':\n perms = full_permissions\n for perm in perms:\n perm_func('{}_{}'.format(perm.lower(), content_type), entity, obj)\n\n set_permissions('users', 'add')\n set_permissions('users', 'remove')\n set_permissions('groups', 'add')\n set_permissions('groups', 'remove')\n\n def set_public_permissions(perm_type):\n \"\"\"Set public permissions.\"\"\"\n perm_func = assign_perm if perm_type == 'add' else remove_perm\n user = AnonymousUser()\n perms = data.get('public', {}).get(perm_type, [])\n if perms == u'ALL':\n perms = full_permissions\n for perm in perms:\n perm_func('{}_{}'.format(perm.lower(), content_type), user, obj)\n\n set_public_permissions('add')\n set_public_permissions('remove')\n\n def get_serializer_class(self):\n \"\"\"Augment base serializer class.\n\n Include permissions information with objects.\n\n \"\"\"\n base_class = super(ResolwePermissionsMixin, self).get_serializer_class()\n\n class SerializerWithPermissions(base_class):\n \"\"\"Augment serializer class.\"\"\"\n\n def to_representation(serializer_self, instance): # pylint: disable=no-self-argument\n \"\"\"Object serializer.\"\"\"\n # TODO: These permissions queries may be expensive. Should we limit or optimize this?\n data = super(SerializerWithPermissions, serializer_self).to_representation(instance)\n data['permissions'] = get_object_perms(instance, self.request.user)\n return data\n\n return SerializerWithPermissions\n\n def _filter_owner_permission(self, data):\n \"\"\"Raise ``PermissionDenied``if ``owner`` found in ``data``.\"\"\"\n for entity_type in ['users', 'groups']:\n if entity_type in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data[entity_type]:\n for entity_id in data[entity_type][perm_type]:\n for perm in data[entity_type][perm_type][entity_id]:\n if perm == 'owner':\n raise exceptions.PermissionDenied(\"Only owners can grant/revoke owner permission\")\n\n def _filter_public_permissions(self, data):\n \"\"\"Raise ``PermissionDenied`` if public permissions are too open.\"\"\"\n allowed_public_permissions = ['view', 'add', 'download']\n\n if 'public' in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data['public']:\n for perm in data['public'][perm_type]:\n if perm not in allowed_public_permissions:\n raise exceptions.PermissionDenied(\"Permissions for public users are too open\")\n\n def _filter_user_permissions(self, data, user_pk):\n \"\"\"Raise ``PermissionDenied`` if ``data`` includes ``user_pk``.\"\"\"\n if 'users' in data:\n for perm_type in ['add', 'remove']:\n if perm_type in data['users']:\n if user_pk in data['users'][perm_type].keys():\n raise exceptions.PermissionDenied(\"You cannot change your own permissions\")\n\n @detail_route(methods=['get', 'post'], url_path='permissions')\n def detail_permissions(self, request, pk=None):\n \"\"\"API endpoint to get/set permissions.\"\"\"\n obj = self.get_object()\n\n if request.method == 'POST':\n content_type = ContentType.objects.get_for_model(obj)\n\n owner_perm = 'owner_{}'.format(content_type)\n if not (request.user.has_perm(owner_perm, obj=obj) or request.user.is_superuser):\n self._filter_owner_permission(request.data)\n self._filter_public_permissions(request.data)\n self._filter_user_permissions(request.data, request.user.pk)\n\n self._update_permission(obj, request.data)\n\n return Response(get_object_perms(obj))\n\n @list_route(methods=['get', 'post'], url_path='permissions')\n def list_permissions(self, request):\n \"\"\"API endpoint to batch get/set permissions.\"\"\"\n # TODO: Implement batch get/set permissions\n return Response(status=status.HTTP_501_NOT_IMPLEMENTED)\n\n\nclass ResolweProcessPermissionsMixin(ResolwePermissionsMixin):\n \"\"\"Process permissions mixin.\"\"\"\n\n def _update_permission(self, obj, data):\n \"\"\"Update collection permissions.\"\"\"\n super(ResolweProcessPermissionsMixin, self)._update_permission(obj, data)\n\n if 'collections' in data:\n if 'add' in data['collections']:\n for _id in data['collections']['add']:\n try:\n Collection.objects.get(pk=_id).public_processes.add(obj)\n except Collection.DoesNotExist:\n pass\n if 'remove' in data['collections']:\n for _id in data['collections']['remove']:\n try:\n Collection.objects.get(pk=_id).public_processes.remove(obj)\n except Collection.DoesNotExist:\n pass\n\n\nclass ResolweCheckSlugMixin(object):\n \"\"\"Slug validation.\"\"\"\n\n @list_route(methods=[u'get'])\n def slug_exists(self, request):\n \"\"\"Check if given url slug exists.\n\n Check if slug given in query parameter ``name`` exists. Return\n ``True`` if slug already exists and ``False`` otherwise.\n\n \"\"\"\n if not request.user.is_authenticated():\n return Response(status=status.HTTP_401_UNAUTHORIZED)\n\n if 'name' not in request.query_params:\n return Response({'error': 'Query parameter `name` must be given.'},\n status=status.HTTP_400_BAD_REQUEST)\n\n queryset = self.get_queryset()\n slug_name = request.query_params['name']\n return Response(queryset.filter(slug__iexact=slug_name).exists())\n\n\nclass CollectionViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n ResolweUpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Collection` objects.\"\"\"\n\n queryset = Collection.objects.all().prefetch_related(\n 'descriptor_schema',\n 'contributor',\n Prefetch('data', queryset=Data.objects.all().order_by('id'))\n )\n serializer_class = CollectionSerializer\n permission_classes = (permissions_cls,)\n filter_class = CollectionFilter\n ordering_fields = ('id', 'created', 'modified', 'name')\n ordering = ('id',)\n\n @detail_route(methods=[u'post'])\n def add_data(self, request, pk=None):\n \"\"\"Add data to collection.\"\"\"\n collection = self.get_object()\n\n if 'ids' not in request.data:\n return Response({\"error\": \"`ids`parameter is required\"}, status=status.HTTP_400_BAD_REQUEST)\n\n missing = []\n for data_id in request.data['ids']:\n if not Data.objects.filter(pk=data_id).exists():\n missing.append(data_id)\n\n if missing:\n return Response(\n {\"error\": \"Data objects with following ids are missing: {}\".format(', '.join(missing))},\n status=status.HTTP_400_BAD_REQUEST)\n\n for data_id in request.data['ids']:\n collection.data.add(data_id)\n\n return Response()\n\n @detail_route(methods=[u'post'])\n def remove_data(self, request, pk=None):\n \"\"\"Remove data from collection.\"\"\"\n collection = self.get_object()\n\n if 'ids' not in request.data:\n return Response({\"error\": \"`ids`parameter is required\"}, status=status.HTTP_400_BAD_REQUEST)\n\n for data_id in request.data['ids']:\n collection.data.remove(data_id)\n\n return Response()\n\n\nclass ProcessViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n ResolweProcessPermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Process` objects.\"\"\"\n\n queryset = Process.objects.all().prefetch_related('contributor')\n serializer_class = ProcessSerializer\n permission_classes = (permissions_cls,)\n filter_class = ProcessFilter\n ordering_fields = ('id', 'created', 'modified', 'name', 'version')\n ordering = ('id',)\n\n\nclass DataViewSet(ResolweCreateDataModelMixin,\n mixins.RetrieveModelMixin,\n ResolweUpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n ResolweCheckSlugMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Data` objects.\"\"\"\n\n queryset = Data.objects.all().prefetch_related('process', 'descriptor_schema', 'contributor')\n serializer_class = DataSerializer\n permission_classes = (permissions_cls,)\n filter_class = DataFilter\n ordering_fields = ('id', 'created', 'modified', 'started', 'finished', 'name')\n ordering = ('id',)\n\n\nclass DescriptorSchemaViewSet(mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`DescriptorSchema` objects.\"\"\"\n\n queryset = DescriptorSchema.objects.all().prefetch_related('contributor')\n serializer_class = DescriptorSchemaSerializer\n permission_classes = (permissions_cls,)\n filter_fields = ('contributor', 'name', 'description', 'created', 'modified', 'slug')\n ordering_fields = ('id', 'created', 'modified', 'name')\n ordering = ('id',)\n\n\nclass TriggerViewSet(ResolweCreateModelMixin,\n mixins.RetrieveModelMixin,\n mixins.UpdateModelMixin,\n mixins.DestroyModelMixin,\n mixins.ListModelMixin,\n ResolwePermissionsMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Trigger` objects.\"\"\"\n\n queryset = Trigger.objects.all().prefetch_related('contributor')\n serializer_class = TriggerSerializer\n permission_classes = (permissions_cls,)\n filter_fields = ('contributor', 'name', 'created', 'modified', 'slug', 'collection')\n\n\nclass StorageViewSet(mixins.RetrieveModelMixin,\n mixins.ListModelMixin,\n viewsets.GenericViewSet):\n \"\"\"API view for :class:`Storage` objects.\"\"\"\n\n queryset = Storage.objects.all().prefetch_related('contributor')\n serializer_class = StorageSerializer\n filter_fields = ('contributor', 'name', 'created', 'modified', 'slug')\n", "path": "resolwe/flow/views.py" } ]	diff --git a/resolwe/flow/tests/test_ordering.py b/resolwe/flow/tests/test_ordering.py new file mode 100644 index 000000000..58ab4126d --- /dev/null +++ b/resolwe/flow/tests/test_ordering.py @@ -0,0 +1,35 @@ +# pylint: disable=missing-docstring +from __future__ import absolute_import, division, print_function, unicode_literals + +from django.contrib.auth import get_user_model +from django.contrib.auth.models import AnonymousUser +from django.core.urlresolvers import reverse + +from guardian.shortcuts import assign_perm +from rest_framework.test import APITestCase + +from resolwe.flow.models import Process + + +class ProcessOrderingTest(APITestCase): + def setUp(self): + user_model = get_user_model() + user = user_model.objects.create(username='user') + + self.proc_1 = Process.objects.create(name='My process', contributor=user, version=1) + self.proc_2 = Process.objects.create(name='My process', contributor=user, version=2) + + assign_perm('view_process', AnonymousUser(), self.proc_1) + assign_perm('view_process', AnonymousUser(), self.proc_2) + + self.url = reverse('resolwe-api:process-list') + + def test_ordering_version(self): + # pylint: disable=no-member + response = self.client.get(self.url, {'ordering': 'version'}, format='json') + self.assertEqual(response.data[0]['id'], self.proc_1.id) + self.assertEqual(response.data[1]['id'], self.proc_2.id) + + response = self.client.get(self.url, {'ordering': '-version'}, format='json') + self.assertEqual(response.data[0]['id'], self.proc_2.id) + self.assertEqual(response.data[1]['id'], self.proc_1.id) diff --git a/resolwe/flow/views.py b/resolwe/flow/views.py index dbe846659..722244706 100644 --- a/resolwe/flow/views.py +++ b/resolwe/flow/views.py @@ -512,7 +512,7 @@ class ProcessViewSet(ResolweCreateModelMixin, serializer_class = ProcessSerializer permission_classes = (permissions_cls,) filter_class = ProcessFilter - ordering_fields = ('id', 'created', 'modified', 'name') + ordering_fields = ('id', 'created', 'modified', 'name', 'version') ordering = ('id',)
ietf-tools__datatracker-4294	cvs export of group documents is dumping b'' strings From Tim Wicinski: >FYI > >So I went and dumped the WG documents via the CSV link: > >https://datatracker.ietf.org/group/dnsop/documents/csv/ > >Then I imported them into the googles sheets. >The CSV file has all strings as "b'<string>'" which >makes the import needing a bit of cleanup. > >tim cc @moonshiner	[ { "content": "# Copyright The IETF Trust 2012-2020, All Rights Reserved\n# -- coding: utf-8 --\n\n\nimport csv\nimport datetime\nimport json\nimport uuid\n\nfrom django.http import HttpResponse, HttpResponseRedirect, Http404\nfrom django.shortcuts import get_object_or_404, render\nfrom django.contrib.auth.decorators import login_required\nfrom django.utils.html import strip_tags\n\nimport debug # pyflakes:ignore\n\nfrom ietf.community.models import SearchRule, EmailSubscription\nfrom ietf.community.forms import SearchRuleTypeForm, SearchRuleForm, AddDocumentsForm, SubscriptionForm\nfrom ietf.community.utils import lookup_community_list, can_manage_community_list\nfrom ietf.community.utils import docs_tracked_by_community_list, docs_matching_community_list_rule\nfrom ietf.community.utils import states_of_significant_change, reset_name_contains_index_for_rule\nfrom ietf.doc.models import DocEvent, Document\nfrom ietf.doc.utils_search import prepare_document_table\nfrom ietf.utils.response import permission_denied\n\ndef view_list(request, username=None):\n clist = lookup_community_list(username)\n\n docs = docs_tracked_by_community_list(clist)\n docs, meta = prepare_document_table(request, docs, request.GET)\n\n subscribed = request.user.is_authenticated and EmailSubscription.objects.filter(community_list=clist, email__person__user=request.user)\n\n return render(request, 'community/view_list.html', {\n 'clist': clist,\n 'docs': docs,\n 'meta': meta,\n 'can_manage_list': can_manage_community_list(request.user, clist),\n 'subscribed': subscribed,\n })\n\n@login_required\ndef manage_list(request, username=None, acronym=None, group_type=None):\n # we need to be a bit careful because clist may not exist in the\n # database so we can't call related stuff on it yet\n clist = lookup_community_list(username, acronym)\n\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n action = request.POST.get('action')\n\n if request.method == 'POST' and action == 'add_documents':\n add_doc_form = AddDocumentsForm(request.POST)\n if add_doc_form.is_valid():\n if clist.pk is None:\n clist.save()\n\n for d in add_doc_form.cleaned_data['documents']:\n if not d in clist.added_docs.all():\n clist.added_docs.add(d)\n\n return HttpResponseRedirect(\"\")\n else:\n add_doc_form = AddDocumentsForm()\n\n if request.method == 'POST' and action == 'remove_document':\n document_id = request.POST.get('document')\n if clist.pk is not None and document_id:\n document = get_object_or_404(clist.added_docs, id=document_id)\n clist.added_docs.remove(document)\n\n return HttpResponseRedirect(\"\")\n\n rule_form = None\n if request.method == 'POST' and action == 'add_rule':\n rule_type_form = SearchRuleTypeForm(request.POST)\n if rule_type_form.is_valid():\n rule_type = rule_type_form.cleaned_data['rule_type']\n\n if rule_type:\n rule_form = SearchRuleForm(clist, rule_type, request.POST)\n if rule_form.is_valid():\n if clist.pk is None:\n clist.save()\n\n rule = rule_form.save(commit=False)\n rule.community_list = clist\n rule.rule_type = rule_type\n rule.save()\n if rule.rule_type == \"name_contains\":\n reset_name_contains_index_for_rule(rule)\n\n return HttpResponseRedirect(\"\")\n else:\n rule_type_form = SearchRuleTypeForm()\n\n if request.method == 'POST' and action == 'remove_rule':\n rule_pk = request.POST.get('rule')\n if clist.pk is not None and rule_pk:\n rule = get_object_or_404(SearchRule, pk=rule_pk, community_list=clist)\n rule.delete()\n\n return HttpResponseRedirect(\"\")\n\n rules = clist.searchrule_set.all() if clist.pk is not None else []\n for r in rules:\n r.matching_documents_count = docs_matching_community_list_rule(r).count()\n\n empty_rule_forms = { rule_type: SearchRuleForm(clist, rule_type) for rule_type, _ in SearchRule.RULE_TYPES }\n\n total_count = docs_tracked_by_community_list(clist).count()\n\n all_forms = [f for f in [rule_type_form, rule_form, add_doc_form, *empty_rule_forms.values()]\n if f is not None]\n return render(request, 'community/manage_list.html', {\n 'clist': clist,\n 'rules': rules,\n 'individually_added': clist.added_docs.all() if clist.pk is not None else [],\n 'rule_type_form': rule_type_form,\n 'rule_form': rule_form,\n 'empty_rule_forms': empty_rule_forms,\n 'total_count': total_count,\n 'add_doc_form': add_doc_form,\n 'all_forms': all_forms,\n })\n\n\n@login_required\ndef track_document(request, name, username=None, acronym=None):\n doc = get_object_or_404(Document, docalias__name=name)\n\n if request.method == \"POST\":\n clist = lookup_community_list(username, acronym)\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n if clist.pk is None:\n clist.save()\n\n if not doc in clist.added_docs.all():\n clist.added_docs.add(doc)\n\n if request.is_ajax():\n return HttpResponse(json.dumps({ 'success': True }), content_type='application/json')\n else:\n return HttpResponseRedirect(clist.get_absolute_url())\n\n return render(request, \"community/track_document.html\", {\n \"name\": doc.name,\n })\n\n@login_required\ndef untrack_document(request, name, username=None, acronym=None):\n doc = get_object_or_404(Document, docalias__name=name)\n clist = lookup_community_list(username, acronym)\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n if request.method == \"POST\":\n if clist.pk is not None:\n clist.added_docs.remove(doc)\n\n if request.is_ajax():\n return HttpResponse(json.dumps({ 'success': True }), content_type='application/json')\n else:\n return HttpResponseRedirect(clist.get_absolute_url())\n\n return render(request, \"community/untrack_document.html\", {\n \"name\": doc.name,\n })\n\n\ndef export_to_csv(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n\n response = HttpResponse(content_type='text/csv')\n\n if clist.group:\n filename = \"%s-draft-list.csv\" % clist.group.acronym\n else:\n filename = \"draft-list.csv\"\n\n response['Content-Disposition'] = 'attachment; filename=%s' % filename\n\n writer = csv.writer(response, dialect=csv.excel, delimiter=str(','))\n\n header = [\n \"Name\",\n \"Title\",\n \"Date of latest revision\",\n \"Status in the IETF process\",\n \"Associated group\",\n \"Associated AD\",\n \"Date of latest change\",\n ]\n writer.writerow(header)\n\n docs = docs_tracked_by_community_list(clist).select_related('type', 'group', 'ad')\n for doc in docs.prefetch_related(\"states\", \"tags\"):\n row = []\n row.append(doc.name)\n row.append(doc.title)\n e = doc.latest_event(type='new_revision')\n row.append(e.time.strftime(\"%Y-%m-%d\") if e else \"\")\n row.append(strip_tags(doc.friendly_state()))\n row.append(doc.group.acronym if doc.group else \"\")\n row.append(str(doc.ad) if doc.ad else \"\")\n e = doc.latest_event()\n row.append(e.time.strftime(\"%Y-%m-%d\") if e else \"\")\n writer.writerow([v.encode(\"utf-8\") for v in row])\n\n return response\n\ndef feed(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n\n significant = request.GET.get('significant', '') == '1'\n\n documents = docs_tracked_by_community_list(clist).values_list('pk', flat=True)\n since = datetime.datetime.now() - datetime.timedelta(days=14)\n\n events = DocEvent.objects.filter(\n doc__id__in=documents,\n time__gte=since,\n ).distinct().order_by('-time', '-id').select_related(\"doc\")\n\n if significant:\n events = events.filter(type=\"changed_state\", statedocevent__state__in=list(states_of_significant_change()))\n\n host = request.get_host()\n feed_url = 'https://%s%s' % (host, request.get_full_path())\n feed_id = uuid.uuid5(uuid.NAMESPACE_URL, str(feed_url))\n title = '%s RSS Feed' % clist.long_name()\n if significant:\n subtitle = 'Significant document changes'\n else:\n subtitle = 'Document changes'\n\n return render(request, 'community/atom.xml', {\n 'clist': clist,\n 'entries': events[:50],\n 'title': title,\n 'subtitle': subtitle,\n 'id': feed_id.urn,\n 'updated': datetime.datetime.now(),\n }, content_type='text/xml')\n\n\n@login_required\ndef subscription(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n if clist.pk is None:\n raise Http404\n\n existing_subscriptions = EmailSubscription.objects.filter(community_list=clist, email__person__user=request.user)\n\n if request.method == 'POST':\n action = request.POST.get(\"action\")\n if action == \"subscribe\":\n form = SubscriptionForm(request.user, clist, request.POST)\n if form.is_valid():\n subscription = form.save(commit=False)\n subscription.community_list = clist\n subscription.save()\n\n return HttpResponseRedirect(\"\")\n\n elif action == \"unsubscribe\":\n existing_subscriptions.filter(pk=request.POST.get(\"subscription_id\")).delete()\n\n return HttpResponseRedirect(\"\")\n else:\n form = SubscriptionForm(request.user, clist)\n\n return render(request, 'community/subscription.html', {\n 'clist': clist,\n 'form': form,\n 'existing_subscriptions': existing_subscriptions,\n })\n", "path": "ietf/community/views.py" } ]	[ { "content": "# Copyright The IETF Trust 2012-2020, All Rights Reserved\n# -- coding: utf-8 --\n\n\nimport csv\nimport datetime\nimport json\nimport uuid\n\nfrom django.http import HttpResponse, HttpResponseRedirect, Http404\nfrom django.shortcuts import get_object_or_404, render\nfrom django.contrib.auth.decorators import login_required\nfrom django.utils.html import strip_tags\n\nimport debug # pyflakes:ignore\n\nfrom ietf.community.models import SearchRule, EmailSubscription\nfrom ietf.community.forms import SearchRuleTypeForm, SearchRuleForm, AddDocumentsForm, SubscriptionForm\nfrom ietf.community.utils import lookup_community_list, can_manage_community_list\nfrom ietf.community.utils import docs_tracked_by_community_list, docs_matching_community_list_rule\nfrom ietf.community.utils import states_of_significant_change, reset_name_contains_index_for_rule\nfrom ietf.doc.models import DocEvent, Document\nfrom ietf.doc.utils_search import prepare_document_table\nfrom ietf.utils.response import permission_denied\n\ndef view_list(request, username=None):\n clist = lookup_community_list(username)\n\n docs = docs_tracked_by_community_list(clist)\n docs, meta = prepare_document_table(request, docs, request.GET)\n\n subscribed = request.user.is_authenticated and EmailSubscription.objects.filter(community_list=clist, email__person__user=request.user)\n\n return render(request, 'community/view_list.html', {\n 'clist': clist,\n 'docs': docs,\n 'meta': meta,\n 'can_manage_list': can_manage_community_list(request.user, clist),\n 'subscribed': subscribed,\n })\n\n@login_required\ndef manage_list(request, username=None, acronym=None, group_type=None):\n # we need to be a bit careful because clist may not exist in the\n # database so we can't call related stuff on it yet\n clist = lookup_community_list(username, acronym)\n\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n action = request.POST.get('action')\n\n if request.method == 'POST' and action == 'add_documents':\n add_doc_form = AddDocumentsForm(request.POST)\n if add_doc_form.is_valid():\n if clist.pk is None:\n clist.save()\n\n for d in add_doc_form.cleaned_data['documents']:\n if not d in clist.added_docs.all():\n clist.added_docs.add(d)\n\n return HttpResponseRedirect(\"\")\n else:\n add_doc_form = AddDocumentsForm()\n\n if request.method == 'POST' and action == 'remove_document':\n document_id = request.POST.get('document')\n if clist.pk is not None and document_id:\n document = get_object_or_404(clist.added_docs, id=document_id)\n clist.added_docs.remove(document)\n\n return HttpResponseRedirect(\"\")\n\n rule_form = None\n if request.method == 'POST' and action == 'add_rule':\n rule_type_form = SearchRuleTypeForm(request.POST)\n if rule_type_form.is_valid():\n rule_type = rule_type_form.cleaned_data['rule_type']\n\n if rule_type:\n rule_form = SearchRuleForm(clist, rule_type, request.POST)\n if rule_form.is_valid():\n if clist.pk is None:\n clist.save()\n\n rule = rule_form.save(commit=False)\n rule.community_list = clist\n rule.rule_type = rule_type\n rule.save()\n if rule.rule_type == \"name_contains\":\n reset_name_contains_index_for_rule(rule)\n\n return HttpResponseRedirect(\"\")\n else:\n rule_type_form = SearchRuleTypeForm()\n\n if request.method == 'POST' and action == 'remove_rule':\n rule_pk = request.POST.get('rule')\n if clist.pk is not None and rule_pk:\n rule = get_object_or_404(SearchRule, pk=rule_pk, community_list=clist)\n rule.delete()\n\n return HttpResponseRedirect(\"\")\n\n rules = clist.searchrule_set.all() if clist.pk is not None else []\n for r in rules:\n r.matching_documents_count = docs_matching_community_list_rule(r).count()\n\n empty_rule_forms = { rule_type: SearchRuleForm(clist, rule_type) for rule_type, _ in SearchRule.RULE_TYPES }\n\n total_count = docs_tracked_by_community_list(clist).count()\n\n all_forms = [f for f in [rule_type_form, rule_form, add_doc_form, *empty_rule_forms.values()]\n if f is not None]\n return render(request, 'community/manage_list.html', {\n 'clist': clist,\n 'rules': rules,\n 'individually_added': clist.added_docs.all() if clist.pk is not None else [],\n 'rule_type_form': rule_type_form,\n 'rule_form': rule_form,\n 'empty_rule_forms': empty_rule_forms,\n 'total_count': total_count,\n 'add_doc_form': add_doc_form,\n 'all_forms': all_forms,\n })\n\n\n@login_required\ndef track_document(request, name, username=None, acronym=None):\n doc = get_object_or_404(Document, docalias__name=name)\n\n if request.method == \"POST\":\n clist = lookup_community_list(username, acronym)\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n if clist.pk is None:\n clist.save()\n\n if not doc in clist.added_docs.all():\n clist.added_docs.add(doc)\n\n if request.is_ajax():\n return HttpResponse(json.dumps({ 'success': True }), content_type='application/json')\n else:\n return HttpResponseRedirect(clist.get_absolute_url())\n\n return render(request, \"community/track_document.html\", {\n \"name\": doc.name,\n })\n\n@login_required\ndef untrack_document(request, name, username=None, acronym=None):\n doc = get_object_or_404(Document, docalias__name=name)\n clist = lookup_community_list(username, acronym)\n if not can_manage_community_list(request.user, clist):\n permission_denied(request, \"You do not have permission to access this view\")\n\n if request.method == \"POST\":\n if clist.pk is not None:\n clist.added_docs.remove(doc)\n\n if request.is_ajax():\n return HttpResponse(json.dumps({ 'success': True }), content_type='application/json')\n else:\n return HttpResponseRedirect(clist.get_absolute_url())\n\n return render(request, \"community/untrack_document.html\", {\n \"name\": doc.name,\n })\n\n\ndef export_to_csv(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n\n response = HttpResponse(content_type='text/csv')\n\n if clist.group:\n filename = \"%s-draft-list.csv\" % clist.group.acronym\n else:\n filename = \"draft-list.csv\"\n\n response['Content-Disposition'] = 'attachment; filename=%s' % filename\n\n writer = csv.writer(response, dialect=csv.excel, delimiter=str(','))\n\n header = [\n \"Name\",\n \"Title\",\n \"Date of latest revision\",\n \"Status in the IETF process\",\n \"Associated group\",\n \"Associated AD\",\n \"Date of latest change\",\n ]\n writer.writerow(header)\n\n docs = docs_tracked_by_community_list(clist).select_related('type', 'group', 'ad')\n for doc in docs.prefetch_related(\"states\", \"tags\"):\n row = []\n row.append(doc.name)\n row.append(doc.title)\n e = doc.latest_event(type='new_revision')\n row.append(e.time.strftime(\"%Y-%m-%d\") if e else \"\")\n row.append(strip_tags(doc.friendly_state()))\n row.append(doc.group.acronym if doc.group else \"\")\n row.append(str(doc.ad) if doc.ad else \"\")\n e = doc.latest_event()\n row.append(e.time.strftime(\"%Y-%m-%d\") if e else \"\")\n writer.writerow(row)\n\n return response\n\ndef feed(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n\n significant = request.GET.get('significant', '') == '1'\n\n documents = docs_tracked_by_community_list(clist).values_list('pk', flat=True)\n since = datetime.datetime.now() - datetime.timedelta(days=14)\n\n events = DocEvent.objects.filter(\n doc__id__in=documents,\n time__gte=since,\n ).distinct().order_by('-time', '-id').select_related(\"doc\")\n\n if significant:\n events = events.filter(type=\"changed_state\", statedocevent__state__in=list(states_of_significant_change()))\n\n host = request.get_host()\n feed_url = 'https://%s%s' % (host, request.get_full_path())\n feed_id = uuid.uuid5(uuid.NAMESPACE_URL, str(feed_url))\n title = '%s RSS Feed' % clist.long_name()\n if significant:\n subtitle = 'Significant document changes'\n else:\n subtitle = 'Document changes'\n\n return render(request, 'community/atom.xml', {\n 'clist': clist,\n 'entries': events[:50],\n 'title': title,\n 'subtitle': subtitle,\n 'id': feed_id.urn,\n 'updated': datetime.datetime.now(),\n }, content_type='text/xml')\n\n\n@login_required\ndef subscription(request, username=None, acronym=None, group_type=None):\n clist = lookup_community_list(username, acronym)\n if clist.pk is None:\n raise Http404\n\n existing_subscriptions = EmailSubscription.objects.filter(community_list=clist, email__person__user=request.user)\n\n if request.method == 'POST':\n action = request.POST.get(\"action\")\n if action == \"subscribe\":\n form = SubscriptionForm(request.user, clist, request.POST)\n if form.is_valid():\n subscription = form.save(commit=False)\n subscription.community_list = clist\n subscription.save()\n\n return HttpResponseRedirect(\"\")\n\n elif action == \"unsubscribe\":\n existing_subscriptions.filter(pk=request.POST.get(\"subscription_id\")).delete()\n\n return HttpResponseRedirect(\"\")\n else:\n form = SubscriptionForm(request.user, clist)\n\n return render(request, 'community/subscription.html', {\n 'clist': clist,\n 'form': form,\n 'existing_subscriptions': existing_subscriptions,\n })\n", "path": "ietf/community/views.py" } ]	diff --git a/ietf/community/views.py b/ietf/community/views.py index 7717c6ee1f..c67f992d6f 100644 --- a/ietf/community/views.py +++ b/ietf/community/views.py @@ -208,7 +208,7 @@ def export_to_csv(request, username=None, acronym=None, group_type=None): row.append(str(doc.ad) if doc.ad else "") e = doc.latest_event() row.append(e.time.strftime("%Y-%m-%d") if e else "") - writer.writerow([v.encode("utf-8") for v in row]) + writer.writerow(row) return response
deis__deis-3308	Controller: Domain remove, removes always the latest domain (deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:list === masterfirefoxos-dev Domains dev.masterfirefoxos.com (deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:add foo.example.com Adding foo.example.com to masterfirefoxos-dev... done (deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:list === masterfirefoxos-dev Domains dev.masterfirefoxos.com foo.example.com (deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:remove dev.masterfirefoxos.com Removing dev.masterfirefoxos.com from masterfirefoxos-dev... done (deis):~/mozilla/deis-apps/masterfirefoxos-dev$ deis domains:list === masterfirefoxos-dev Domains dev.masterfirefoxos.com	[ { "content": "\"\"\"\nRESTful view classes for presenting Deis API objects.\n\"\"\"\n\nfrom django.conf import settings\nfrom django.core.exceptions import ValidationError\nfrom django.contrib.auth.models import User\nfrom django.shortcuts import get_object_or_404\nfrom guardian.shortcuts import assign_perm, get_objects_for_user, \\\n get_users_with_perms, remove_perm\nfrom rest_framework import mixins, renderers, status\nfrom rest_framework.decorators import permission_classes\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.permissions import IsAuthenticated\nfrom rest_framework.response import Response\nfrom rest_framework.viewsets import GenericViewSet\n\nfrom api import authentication, models, permissions, serializers, viewsets\n\n\nclass UserRegistrationViewSet(GenericViewSet,\n mixins.CreateModelMixin):\n \"\"\"ViewSet to handle registering new users. The logic is in the serializer.\"\"\"\n authentication_classes = [authentication.AnonymousAuthentication]\n permission_classes = [permissions.IsAnonymous, permissions.HasRegistrationAuth]\n serializer_class = serializers.UserSerializer\n\n\nclass UserManagementViewSet(GenericViewSet,\n mixins.DestroyModelMixin):\n serializer_class = serializers.UserSerializer\n\n def get_queryset(self):\n return User.objects.filter(pk=self.request.user.pk)\n\n def get_object(self):\n return self.get_queryset()[0]\n\n def passwd(self, request, *kwargs):\n obj = self.get_object()\n if not obj.check_password(request.data['password']):\n return Response({'detail': 'Current password does not match'},\n status=status.HTTP_400_BAD_REQUEST)\n obj.set_password(request.data['new_password'])\n obj.save()\n return Response({'status': 'password set'})\n\n\nclass BaseDeisViewSet(viewsets.OwnerViewSet):\n \"\"\"\n A generic ViewSet for objects related to Deis.\n\n To use it, at minimum you'll need to provide the `serializer_class` attribute and\n the `model` attribute shortcut.\n \"\"\"\n lookup_field = 'id'\n permission_classes = [IsAuthenticated, permissions.IsAppUser]\n renderer_classes = [renderers.JSONRenderer]\n\n def create(self, request, args, *kwargs):\n try:\n return super(BaseDeisViewSet, self).create(request, args, kwargs)\n # If the scheduler oopsie'd\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n\n\nclass AppResourceViewSet(BaseDeisViewSet):\n \"\"\"A viewset for objects which are attached to an application.\"\"\"\n\n def get_app(self):\n app = get_object_or_404(models.App, id=self.kwargs['id'])\n self.check_object_permissions(self.request, app)\n return app\n\n def get_queryset(self, kwargs):\n app = self.get_app()\n return self.model.objects.filter(app=app)\n\n def get_object(self, kwargs):\n return self.get_queryset(kwargs).latest('created')\n\n def create(self, request, kwargs):\n request.data['app'] = self.get_app()\n return super(AppResourceViewSet, self).create(request, kwargs)\n\n\nclass ReleasableViewSet(AppResourceViewSet):\n \"\"\"A viewset for application resources which affect the release cycle.\n\n When a resource is created, a new release is created for the application\n and it returns some success headers regarding the new release.\n\n To use it, at minimum you'll need to provide a `release` attribute tied to your class before\n calling post_save().\n \"\"\"\n def get_object(self):\n \"\"\"Retrieve the object based on the latest release's value\"\"\"\n return getattr(self.get_app().release_set.latest(), self.model.__name__.lower())\n\n def get_success_headers(self, data, *kwargs):\n headers = super(ReleasableViewSet, self).get_success_headers(data)\n headers.update({'X-Deis-Release': self.release.version})\n return headers\n\n\nclass AppViewSet(BaseDeisViewSet):\n \"\"\"A viewset for interacting with App objects.\"\"\"\n model = models.App\n serializer_class = serializers.AppSerializer\n\n def get_queryset(self, args, *kwargs):\n return self.model.objects.all(args, *kwargs)\n\n def list(self, request, args, kwargs):\n \"\"\"\n HACK: Instead of filtering by the queryset, we limit the queryset to list only the apps\n which are owned by the user as well as any apps they have been given permission to\n interact with.\n \"\"\"\n queryset = super(AppViewSet, self).get_queryset(kwargs) \| \\\n get_objects_for_user(self.request.user, 'api.use_app')\n instance = self.filter_queryset(queryset)\n page = self.paginate_queryset(instance)\n if page is not None:\n serializer = self.get_pagination_serializer(page)\n else:\n serializer = self.get_serializer(instance, many=True)\n return Response(serializer.data)\n\n def post_save(self, app):\n app.create()\n\n def scale(self, request, kwargs):\n new_structure = {}\n app = self.get_object()\n try:\n for target, count in request.data.items():\n new_structure[target] = int(count)\n models.validate_app_structure(new_structure)\n app.scale(request.user, new_structure)\n except (TypeError, ValueError):\n return Response({'detail': 'Invalid scaling format'},\n status=status.HTTP_400_BAD_REQUEST)\n except (EnvironmentError, ValidationError) as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n return Response(status=status.HTTP_204_NO_CONTENT)\n\n def logs(self, request, kwargs):\n app = self.get_object()\n try:\n return Response(app.logs(), status=status.HTTP_200_OK, content_type='text/plain')\n except EnvironmentError:\n return Response(\"No logs for {}\".format(app.id),\n status=status.HTTP_204_NO_CONTENT,\n content_type='text/plain')\n\n def run(self, request, kwargs):\n app = self.get_object()\n try:\n output_and_rc = app.run(self.request.user, request.data['command'])\n except EnvironmentError as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n return Response(output_and_rc, status=status.HTTP_200_OK,\n content_type='text/plain')\n\n\nclass BuildViewSet(ReleasableViewSet):\n \"\"\"A viewset for interacting with Build objects.\"\"\"\n model = models.Build\n serializer_class = serializers.BuildSerializer\n\n def post_save(self, build):\n self.release = build.create(self.request.user)\n super(BuildViewSet, self).post_save(build)\n\n\nclass ConfigViewSet(ReleasableViewSet):\n \"\"\"A viewset for interacting with Config objects.\"\"\"\n model = models.Config\n serializer_class = serializers.ConfigSerializer\n\n def post_save(self, config):\n release = config.app.release_set.latest()\n self.release = release.new(self.request.user, config=config, build=release.build)\n try:\n config.app.deploy(self.request.user, self.release)\n except RuntimeError:\n self.release.delete()\n raise\n\n\nclass ContainerViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Container objects.\"\"\"\n model = models.Container\n serializer_class = serializers.ContainerSerializer\n\n def get_queryset(self, kwargs):\n qs = super(ContainerViewSet, self).get_queryset(kwargs)\n container_type = self.kwargs.get('type')\n if container_type:\n qs = qs.filter(type=container_type)\n else:\n qs = qs.exclude(type='run')\n return qs\n\n def get_object(self, kwargs):\n qs = self.get_queryset(kwargs)\n return qs.get(num=self.kwargs['num'])\n\n\nclass DomainViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Domain objects.\"\"\"\n model = models.Domain\n serializer_class = serializers.DomainSerializer\n\n\nclass KeyViewSet(BaseDeisViewSet):\n \"\"\"A viewset for interacting with Key objects.\"\"\"\n model = models.Key\n serializer_class = serializers.KeySerializer\n\n\nclass ReleaseViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Release objects.\"\"\"\n model = models.Release\n serializer_class = serializers.ReleaseSerializer\n\n def get_object(self, kwargs):\n \"\"\"Get release by version always\"\"\"\n return self.get_queryset(kwargs).get(version=self.kwargs['version'])\n\n def rollback(self, request, kwargs):\n \"\"\"\n Create a new release as a copy of the state of the compiled slug and config vars of a\n previous release.\n \"\"\"\n app = self.get_app()\n try:\n release = app.release_set.latest()\n version_to_rollback_to = release.version - 1\n if request.data.get('version'):\n version_to_rollback_to = int(request.data['version'])\n new_release = release.rollback(request.user, version_to_rollback_to)\n response = {'version': new_release.version}\n return Response(response, status=status.HTTP_201_CREATED)\n except EnvironmentError as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError:\n new_release.delete()\n raise\n\n\nclass BaseHookViewSet(BaseDeisViewSet):\n permission_classes = [permissions.HasBuilderAuth]\n\n\nclass PushHookViewSet(BaseHookViewSet):\n \"\"\"API hook to create new :class:`~api.models.Push`\"\"\"\n model = models.Push\n serializer_class = serializers.PushSerializer\n\n def create(self, request, args, kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n request.data['app'] = app\n request.data['owner'] = request.user\n return super(PushHookViewSet, self).create(request, args, *kwargs)\n\n\nclass BuildHookViewSet(BaseHookViewSet):\n \"\"\"API hook to create new :class:`~api.models.Build`\"\"\"\n model = models.Build\n serializer_class = serializers.BuildSerializer\n\n def create(self, request, args, *kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n self.user = request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n request.data['app'] = app\n request.data['owner'] = self.user\n super(BuildHookViewSet, self).create(request, args, *kwargs)\n # return the application databag\n response = {'release': {'version': app.release_set.latest().version},\n 'domains': ['.'.join([app.id, settings.DEIS_DOMAIN])]}\n return Response(response, status=status.HTTP_200_OK)\n\n def post_save(self, build):\n build.create(self.user)\n\n\nclass ConfigHookViewSet(BaseHookViewSet):\n \"\"\"API hook to grab latest :class:`~api.models.Config`\"\"\"\n model = models.Config\n serializer_class = serializers.ConfigSerializer\n\n def create(self, request, args, kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n config = app.release_set.latest().config\n serializer = self.get_serializer(config)\n return Response(serializer.data, status=status.HTTP_200_OK)\n\n\nclass AppPermsViewSet(BaseDeisViewSet):\n \"\"\"RESTful views for sharing apps with collaborators.\"\"\"\n\n model = models.App # models class\n perm = 'use_app' # short name for permission\n\n def get_queryset(self):\n return self.model.objects.all()\n\n @permission_classes([permissions.IsAppUser])\n def list(self, request, kwargs):\n app = self.get_object()\n perm_name = \"api.{}\".format(self.perm)\n usernames = [u.username for u in get_users_with_perms(app)\n if u.has_perm(perm_name, app)]\n return Response({'users': usernames})\n\n @permission_classes([permissions.IsOwnerOrAdmin])\n def create(self, request, kwargs):\n app = self.get_object()\n user = get_object_or_404(User, username=request.data['username'])\n assign_perm(self.perm, user, app)\n models.log_event(app, \"User {} was granted access to {}\".format(user, app))\n return Response(status=status.HTTP_201_CREATED)\n\n @permission_classes([permissions.IsOwnerOrAdmin])\n def destroy(self, request, kwargs):\n app = self.get_object()\n user = get_object_or_404(User, username=kwargs['username'])\n if not user.has_perm(self.perm, app):\n raise PermissionDenied()\n remove_perm(self.perm, user, app)\n models.log_event(app, \"User {} was revoked access to {}\".format(user, app))\n return Response(status=status.HTTP_204_NO_CONTENT)\n\n\nclass AdminPermsViewSet(BaseDeisViewSet):\n \"\"\"RESTful views for sharing admin permissions with other users.\"\"\"\n\n model = User\n serializer_class = serializers.AdminUserSerializer\n permission_classes = [permissions.IsAdmin]\n\n def get_queryset(self, kwargs):\n self.check_object_permissions(self.request, self.request.user)\n return self.model.objects.filter(is_active=True, is_superuser=True)\n\n def create(self, request, kwargs):\n user = get_object_or_404(User, username=request.data['username'])\n user.is_superuser = user.is_staff = True\n user.save(update_fields=['is_superuser', 'is_staff'])\n return Response(status=status.HTTP_201_CREATED)\n\n def destroy(self, request, **kwargs):\n user = get_object_or_404(User, username=kwargs['username'])\n user.is_superuser = user.is_staff = False\n user.save(update_fields=['is_superuser', 'is_staff'])\n return Response(status=status.HTTP_204_NO_CONTENT)\n", "path": "controller/api/views.py" } ]	[ { "content": "\"\"\"\nRESTful view classes for presenting Deis API objects.\n\"\"\"\n\nfrom django.conf import settings\nfrom django.core.exceptions import ValidationError\nfrom django.contrib.auth.models import User\nfrom django.shortcuts import get_object_or_404\nfrom guardian.shortcuts import assign_perm, get_objects_for_user, \\\n get_users_with_perms, remove_perm\nfrom rest_framework import mixins, renderers, status\nfrom rest_framework.decorators import permission_classes\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.permissions import IsAuthenticated\nfrom rest_framework.response import Response\nfrom rest_framework.viewsets import GenericViewSet\n\nfrom api import authentication, models, permissions, serializers, viewsets\n\n\nclass UserRegistrationViewSet(GenericViewSet,\n mixins.CreateModelMixin):\n \"\"\"ViewSet to handle registering new users. The logic is in the serializer.\"\"\"\n authentication_classes = [authentication.AnonymousAuthentication]\n permission_classes = [permissions.IsAnonymous, permissions.HasRegistrationAuth]\n serializer_class = serializers.UserSerializer\n\n\nclass UserManagementViewSet(GenericViewSet,\n mixins.DestroyModelMixin):\n serializer_class = serializers.UserSerializer\n\n def get_queryset(self):\n return User.objects.filter(pk=self.request.user.pk)\n\n def get_object(self):\n return self.get_queryset()[0]\n\n def passwd(self, request, *kwargs):\n obj = self.get_object()\n if not obj.check_password(request.data['password']):\n return Response({'detail': 'Current password does not match'},\n status=status.HTTP_400_BAD_REQUEST)\n obj.set_password(request.data['new_password'])\n obj.save()\n return Response({'status': 'password set'})\n\n\nclass BaseDeisViewSet(viewsets.OwnerViewSet):\n \"\"\"\n A generic ViewSet for objects related to Deis.\n\n To use it, at minimum you'll need to provide the `serializer_class` attribute and\n the `model` attribute shortcut.\n \"\"\"\n lookup_field = 'id'\n permission_classes = [IsAuthenticated, permissions.IsAppUser]\n renderer_classes = [renderers.JSONRenderer]\n\n def create(self, request, args, *kwargs):\n try:\n return super(BaseDeisViewSet, self).create(request, args, kwargs)\n # If the scheduler oopsie'd\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n\n\nclass AppResourceViewSet(BaseDeisViewSet):\n \"\"\"A viewset for objects which are attached to an application.\"\"\"\n\n def get_app(self):\n app = get_object_or_404(models.App, id=self.kwargs['id'])\n self.check_object_permissions(self.request, app)\n return app\n\n def get_queryset(self, kwargs):\n app = self.get_app()\n return self.model.objects.filter(app=app)\n\n def get_object(self, kwargs):\n return self.get_queryset(kwargs).latest('created')\n\n def create(self, request, kwargs):\n request.data['app'] = self.get_app()\n return super(AppResourceViewSet, self).create(request, kwargs)\n\n\nclass ReleasableViewSet(AppResourceViewSet):\n \"\"\"A viewset for application resources which affect the release cycle.\n\n When a resource is created, a new release is created for the application\n and it returns some success headers regarding the new release.\n\n To use it, at minimum you'll need to provide a `release` attribute tied to your class before\n calling post_save().\n \"\"\"\n def get_object(self):\n \"\"\"Retrieve the object based on the latest release's value\"\"\"\n return getattr(self.get_app().release_set.latest(), self.model.__name__.lower())\n\n def get_success_headers(self, data, *kwargs):\n headers = super(ReleasableViewSet, self).get_success_headers(data)\n headers.update({'X-Deis-Release': self.release.version})\n return headers\n\n\nclass AppViewSet(BaseDeisViewSet):\n \"\"\"A viewset for interacting with App objects.\"\"\"\n model = models.App\n serializer_class = serializers.AppSerializer\n\n def get_queryset(self, args, *kwargs):\n return self.model.objects.all(args, *kwargs)\n\n def list(self, request, args, kwargs):\n \"\"\"\n HACK: Instead of filtering by the queryset, we limit the queryset to list only the apps\n which are owned by the user as well as any apps they have been given permission to\n interact with.\n \"\"\"\n queryset = super(AppViewSet, self).get_queryset(kwargs) \| \\\n get_objects_for_user(self.request.user, 'api.use_app')\n instance = self.filter_queryset(queryset)\n page = self.paginate_queryset(instance)\n if page is not None:\n serializer = self.get_pagination_serializer(page)\n else:\n serializer = self.get_serializer(instance, many=True)\n return Response(serializer.data)\n\n def post_save(self, app):\n app.create()\n\n def scale(self, request, kwargs):\n new_structure = {}\n app = self.get_object()\n try:\n for target, count in request.data.items():\n new_structure[target] = int(count)\n models.validate_app_structure(new_structure)\n app.scale(request.user, new_structure)\n except (TypeError, ValueError):\n return Response({'detail': 'Invalid scaling format'},\n status=status.HTTP_400_BAD_REQUEST)\n except (EnvironmentError, ValidationError) as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n return Response(status=status.HTTP_204_NO_CONTENT)\n\n def logs(self, request, kwargs):\n app = self.get_object()\n try:\n return Response(app.logs(), status=status.HTTP_200_OK, content_type='text/plain')\n except EnvironmentError:\n return Response(\"No logs for {}\".format(app.id),\n status=status.HTTP_204_NO_CONTENT,\n content_type='text/plain')\n\n def run(self, request, kwargs):\n app = self.get_object()\n try:\n output_and_rc = app.run(self.request.user, request.data['command'])\n except EnvironmentError as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError as e:\n return Response({'detail': str(e)}, status=status.HTTP_503_SERVICE_UNAVAILABLE)\n return Response(output_and_rc, status=status.HTTP_200_OK,\n content_type='text/plain')\n\n\nclass BuildViewSet(ReleasableViewSet):\n \"\"\"A viewset for interacting with Build objects.\"\"\"\n model = models.Build\n serializer_class = serializers.BuildSerializer\n\n def post_save(self, build):\n self.release = build.create(self.request.user)\n super(BuildViewSet, self).post_save(build)\n\n\nclass ConfigViewSet(ReleasableViewSet):\n \"\"\"A viewset for interacting with Config objects.\"\"\"\n model = models.Config\n serializer_class = serializers.ConfigSerializer\n\n def post_save(self, config):\n release = config.app.release_set.latest()\n self.release = release.new(self.request.user, config=config, build=release.build)\n try:\n config.app.deploy(self.request.user, self.release)\n except RuntimeError:\n self.release.delete()\n raise\n\n\nclass ContainerViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Container objects.\"\"\"\n model = models.Container\n serializer_class = serializers.ContainerSerializer\n\n def get_queryset(self, kwargs):\n qs = super(ContainerViewSet, self).get_queryset(kwargs)\n container_type = self.kwargs.get('type')\n if container_type:\n qs = qs.filter(type=container_type)\n else:\n qs = qs.exclude(type='run')\n return qs\n\n def get_object(self, kwargs):\n qs = self.get_queryset(kwargs)\n return qs.get(num=self.kwargs['num'])\n\n\nclass DomainViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Domain objects.\"\"\"\n model = models.Domain\n serializer_class = serializers.DomainSerializer\n\n def get_object(self, kwargs):\n return self.get_queryset(kwargs)\n\n\nclass KeyViewSet(BaseDeisViewSet):\n \"\"\"A viewset for interacting with Key objects.\"\"\"\n model = models.Key\n serializer_class = serializers.KeySerializer\n\n\nclass ReleaseViewSet(AppResourceViewSet):\n \"\"\"A viewset for interacting with Release objects.\"\"\"\n model = models.Release\n serializer_class = serializers.ReleaseSerializer\n\n def get_object(self, kwargs):\n \"\"\"Get release by version always\"\"\"\n return self.get_queryset(kwargs).get(version=self.kwargs['version'])\n\n def rollback(self, request, kwargs):\n \"\"\"\n Create a new release as a copy of the state of the compiled slug and config vars of a\n previous release.\n \"\"\"\n app = self.get_app()\n try:\n release = app.release_set.latest()\n version_to_rollback_to = release.version - 1\n if request.data.get('version'):\n version_to_rollback_to = int(request.data['version'])\n new_release = release.rollback(request.user, version_to_rollback_to)\n response = {'version': new_release.version}\n return Response(response, status=status.HTTP_201_CREATED)\n except EnvironmentError as e:\n return Response({'detail': str(e)}, status=status.HTTP_400_BAD_REQUEST)\n except RuntimeError:\n new_release.delete()\n raise\n\n\nclass BaseHookViewSet(BaseDeisViewSet):\n permission_classes = [permissions.HasBuilderAuth]\n\n\nclass PushHookViewSet(BaseHookViewSet):\n \"\"\"API hook to create new :class:`~api.models.Push`\"\"\"\n model = models.Push\n serializer_class = serializers.PushSerializer\n\n def create(self, request, args, kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n request.data['app'] = app\n request.data['owner'] = request.user\n return super(PushHookViewSet, self).create(request, args, *kwargs)\n\n\nclass BuildHookViewSet(BaseHookViewSet):\n \"\"\"API hook to create new :class:`~api.models.Build`\"\"\"\n model = models.Build\n serializer_class = serializers.BuildSerializer\n\n def create(self, request, args, *kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n self.user = request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n request.data['app'] = app\n request.data['owner'] = self.user\n super(BuildHookViewSet, self).create(request, args, *kwargs)\n # return the application databag\n response = {'release': {'version': app.release_set.latest().version},\n 'domains': ['.'.join([app.id, settings.DEIS_DOMAIN])]}\n return Response(response, status=status.HTTP_200_OK)\n\n def post_save(self, build):\n build.create(self.user)\n\n\nclass ConfigHookViewSet(BaseHookViewSet):\n \"\"\"API hook to grab latest :class:`~api.models.Config`\"\"\"\n model = models.Config\n serializer_class = serializers.ConfigSerializer\n\n def create(self, request, args, kwargs):\n app = get_object_or_404(models.App, id=request.data['receive_repo'])\n request.user = get_object_or_404(User, username=request.data['receive_user'])\n # check the user is authorized for this app\n if not permissions.is_app_user(request, app):\n raise PermissionDenied()\n config = app.release_set.latest().config\n serializer = self.get_serializer(config)\n return Response(serializer.data, status=status.HTTP_200_OK)\n\n\nclass AppPermsViewSet(BaseDeisViewSet):\n \"\"\"RESTful views for sharing apps with collaborators.\"\"\"\n\n model = models.App # models class\n perm = 'use_app' # short name for permission\n\n def get_queryset(self):\n return self.model.objects.all()\n\n @permission_classes([permissions.IsAppUser])\n def list(self, request, kwargs):\n app = self.get_object()\n perm_name = \"api.{}\".format(self.perm)\n usernames = [u.username for u in get_users_with_perms(app)\n if u.has_perm(perm_name, app)]\n return Response({'users': usernames})\n\n @permission_classes([permissions.IsOwnerOrAdmin])\n def create(self, request, kwargs):\n app = self.get_object()\n user = get_object_or_404(User, username=request.data['username'])\n assign_perm(self.perm, user, app)\n models.log_event(app, \"User {} was granted access to {}\".format(user, app))\n return Response(status=status.HTTP_201_CREATED)\n\n @permission_classes([permissions.IsOwnerOrAdmin])\n def destroy(self, request, kwargs):\n app = self.get_object()\n user = get_object_or_404(User, username=kwargs['username'])\n if not user.has_perm(self.perm, app):\n raise PermissionDenied()\n remove_perm(self.perm, user, app)\n models.log_event(app, \"User {} was revoked access to {}\".format(user, app))\n return Response(status=status.HTTP_204_NO_CONTENT)\n\n\nclass AdminPermsViewSet(BaseDeisViewSet):\n \"\"\"RESTful views for sharing admin permissions with other users.\"\"\"\n\n model = User\n serializer_class = serializers.AdminUserSerializer\n permission_classes = [permissions.IsAdmin]\n\n def get_queryset(self, kwargs):\n self.check_object_permissions(self.request, self.request.user)\n return self.model.objects.filter(is_active=True, is_superuser=True)\n\n def create(self, request, kwargs):\n user = get_object_or_404(User, username=request.data['username'])\n user.is_superuser = user.is_staff = True\n user.save(update_fields=['is_superuser', 'is_staff'])\n return Response(status=status.HTTP_201_CREATED)\n\n def destroy(self, request, **kwargs):\n user = get_object_or_404(User, username=kwargs['username'])\n user.is_superuser = user.is_staff = False\n user.save(update_fields=['is_superuser', 'is_staff'])\n return Response(status=status.HTTP_204_NO_CONTENT)\n", "path": "controller/api/views.py" } ]	diff --git a/controller/api/tests/test_domain.py b/controller/api/tests/test_domain.py index 7b8d98f927..b3bbe5675a 100644 --- a/controller/api/tests/test_domain.py +++ b/controller/api/tests/test_domain.py @@ -12,6 +12,8 @@ from django.test import TestCase from rest_framework.authtoken.models import Token +from api.models import Domain + class DomainTest(TestCase): @@ -78,6 +80,26 @@ def test_manage_domain(self): HTTP_AUTHORIZATION='token {}'.format(self.token)) self.assertEqual(0, response.data['count'], msg) + def test_delete_domain_does_not_remove_latest(self): + """https://github.com/deis/deis/issues/3239""" + url = '/v1/apps/{app_id}/domains'.format(app_id=self.app_id) + test_domains = [ + 'test-domain.example.com', + 'django.paas-sandbox', + ] + for domain in test_domains: + body = {'domain': domain} + response = self.client.post(url, json.dumps(body), content_type='application/json', + HTTP_AUTHORIZATION='token {}'.format(self.token)) + self.assertEqual(response.status_code, 201) + url = '/v1/apps/{app_id}/domains/{domain}'.format(domain=test_domains[0], + app_id=self.app_id) + response = self.client.delete(url, content_type='application/json', + HTTP_AUTHORIZATION='token {}'.format(self.token)) + self.assertEqual(response.status_code, 204) + with self.assertRaises(Domain.DoesNotExist): + Domain.objects.get(domain=test_domains[0]) + def test_manage_domain_invalid_app(self): url = '/v1/apps/{app_id}/domains'.format(app_id="this-app-does-not-exist") body = {'domain': 'test-domain.example.com'} diff --git a/controller/api/views.py b/controller/api/views.py index 9e01a85136..27a0d004cc 100644 --- a/controller/api/views.py +++ b/controller/api/views.py @@ -218,6 +218,9 @@ class DomainViewSet(AppResourceViewSet): model = models.Domain serializer_class = serializers.DomainSerializer + def get_object(self, kwargs): + return self.get_queryset(kwargs) + class KeyViewSet(BaseDeisViewSet): """A viewset for interacting with Key objects."""
mlflow__mlflow-6881	[FR] Add the ability to search runs based on 'user_id' ### Willingness to contribute No. I cannot contribute this feature at this time. ### Proposal Summary Enable run search to perform searches based on the `user_id` that submitted the run. ### Motivation > #### What is the use case for this feature? To return runs that have been initiated by a particular user while using run search functionality. > #### Why is this use case valuable to support for MLflow users in general? Quality of life improvement for navigating within the UI > #### Why is this use case valuable to support for your project(s) or organization? > #### Why is it currently difficult to achieve this use case? It is not supported right now. ### Details _No response_ ### What component(s) does this bug affect? - [ ] `area/artifacts`: Artifact stores and artifact logging - [ ] `area/build`: Build and test infrastructure for MLflow - [ ] `area/docs`: MLflow documentation pages - [ ] `area/examples`: Example code - [ ] `area/model-registry`: Model Registry service, APIs, and the fluent client calls for Model Registry - [ ] `area/models`: MLmodel format, model serialization/deserialization, flavors - [ ] `area/pipelines`: Pipelines, Pipeline APIs, Pipeline configs, Pipeline Templates - [ ] `area/projects`: MLproject format, project running backends - [ ] `area/scoring`: MLflow Model server, model deployment tools, Spark UDFs - [ ] `area/server-infra`: MLflow Tracking server backend - [X] `area/tracking`: Tracking Service, tracking client APIs, autologging ### What interface(s) does this bug affect? - [ ] `area/uiux`: Front-end, user experience, plotting, JavaScript, JavaScript dev server - [ ] `area/docker`: Docker use across MLflow's components, such as MLflow Projects and MLflow Models - [ ] `area/sqlalchemy`: Use of SQLAlchemy in the Tracking Service or Model Registry - [ ] `area/windows`: Windows support ### What language(s) does this bug affect? - [ ] `language/r`: R APIs and clients - [ ] `language/java`: Java APIs and clients - [ ] `language/new`: Proposals for new client languages ### What integration(s) does this bug affect? - [ ] `integrations/azure`: Azure and Azure ML integrations - [ ] `integrations/sagemaker`: SageMaker integrations - [ ] `integrations/databricks`: Databricks integrations	[ { "content": "from mlflow.entities.run_status import RunStatus\nfrom mlflow.entities._mlflow_object import _MLflowObject\nfrom mlflow.entities.lifecycle_stage import LifecycleStage\nfrom mlflow.exceptions import MlflowException\n\nfrom mlflow.protos.service_pb2 import RunInfo as ProtoRunInfo\nfrom mlflow.protos.databricks_pb2 import INVALID_PARAMETER_VALUE\n\n\ndef check_run_is_active(run_info):\n if run_info.lifecycle_stage != LifecycleStage.ACTIVE:\n raise MlflowException(\n \"The run {} must be in 'active' lifecycle_stage.\".format(run_info.run_id),\n error_code=INVALID_PARAMETER_VALUE,\n )\n\n\nclass searchable_attribute(property):\n # Wrapper class over property to designate some of the properties as searchable\n # run attributes\n pass\n\n\nclass orderable_attribute(property):\n # Wrapper class over property to designate some of the properties as orderable\n # run attributes\n pass\n\n\nclass RunInfo(_MLflowObject):\n \"\"\"\n Metadata about a run.\n \"\"\"\n\n def __init__(\n self,\n run_uuid,\n experiment_id,\n user_id,\n status,\n start_time,\n end_time,\n lifecycle_stage,\n artifact_uri=None,\n run_id=None,\n run_name=None,\n ):\n if experiment_id is None:\n raise Exception(\"experiment_id cannot be None\")\n if user_id is None:\n raise Exception(\"user_id cannot be None\")\n if status is None:\n raise Exception(\"status cannot be None\")\n if start_time is None:\n raise Exception(\"start_time cannot be None\")\n actual_run_id = run_id or run_uuid\n if actual_run_id is None:\n raise Exception(\"run_id and run_uuid cannot both be None\")\n self._run_uuid = actual_run_id\n self._run_id = actual_run_id\n self._experiment_id = experiment_id\n self._user_id = user_id\n self._status = status\n self._start_time = start_time\n self._end_time = end_time\n self._lifecycle_stage = lifecycle_stage\n self._artifact_uri = artifact_uri\n self._run_name = run_name\n\n def __eq__(self, other):\n if type(other) is type(self):\n # TODO deep equality here?\n return self.__dict__ == other.__dict__\n return False\n\n def _copy_with_overrides(self, status=None, end_time=None, lifecycle_stage=None, run_name=None):\n \"\"\"A copy of the RunInfo with certain attributes modified.\"\"\"\n proto = self.to_proto()\n if status:\n proto.status = status\n if end_time:\n proto.end_time = end_time\n if lifecycle_stage:\n proto.lifecycle_stage = lifecycle_stage\n if run_name:\n proto.run_name = run_name\n return RunInfo.from_proto(proto)\n\n @property\n def run_uuid(self):\n \"\"\"[Deprecated, use run_id instead] String containing run UUID.\"\"\"\n return self._run_uuid\n\n @property\n def run_id(self):\n \"\"\"String containing run id.\"\"\"\n return self._run_id\n\n @property\n def experiment_id(self):\n \"\"\"String ID of the experiment for the current run.\"\"\"\n return self._experiment_id\n\n @property\n def run_name(self):\n \"\"\"String containing run name.\"\"\"\n return self._run_name\n\n def _set_run_name(self, new_name):\n self._run_name = new_name\n\n @property\n def user_id(self):\n \"\"\"String ID of the user who initiated this run.\"\"\"\n return self._user_id\n\n @searchable_attribute\n def status(self):\n \"\"\"\n One of the values in :py:class:`mlflow.entities.RunStatus`\n describing the status of the run.\n \"\"\"\n return self._status\n\n @searchable_attribute\n def start_time(self):\n \"\"\"Start time of the run, in number of milliseconds since the UNIX epoch.\"\"\"\n return self._start_time\n\n @searchable_attribute\n def end_time(self):\n \"\"\"End time of the run, in number of milliseconds since the UNIX epoch.\"\"\"\n return self._end_time\n\n @searchable_attribute\n def artifact_uri(self):\n \"\"\"String root artifact URI of the run.\"\"\"\n return self._artifact_uri\n\n @property\n def lifecycle_stage(self):\n return self._lifecycle_stage\n\n def to_proto(self):\n proto = ProtoRunInfo()\n proto.run_uuid = self.run_uuid\n proto.run_id = self.run_id\n if self.run_name is not None:\n proto.run_name = self.run_name\n proto.experiment_id = self.experiment_id\n proto.user_id = self.user_id\n proto.status = RunStatus.from_string(self.status)\n proto.start_time = self.start_time\n if self.end_time:\n proto.end_time = self.end_time\n if self.artifact_uri:\n proto.artifact_uri = self.artifact_uri\n proto.lifecycle_stage = self.lifecycle_stage\n return proto\n\n @classmethod\n def from_proto(cls, proto):\n end_time = proto.end_time\n # The proto2 default scalar value of zero indicates that the run's end time is absent.\n # An absent end time is represented with a NoneType in the `RunInfo` class\n if end_time == 0:\n end_time = None\n return cls(\n run_uuid=proto.run_uuid,\n run_id=proto.run_id,\n run_name=proto.run_name,\n experiment_id=proto.experiment_id,\n user_id=proto.user_id,\n status=RunStatus.to_string(proto.status),\n start_time=proto.start_time,\n end_time=end_time,\n lifecycle_stage=proto.lifecycle_stage,\n artifact_uri=proto.artifact_uri,\n )\n\n @classmethod\n def get_searchable_attributes(cls):\n return sorted(\n [p for p in cls.__dict__ if isinstance(getattr(cls, p), searchable_attribute)]\n )\n\n @classmethod\n def get_orderable_attributes(cls):\n # Note that all searchable attributes are also orderable.\n return sorted(\n [\n p\n for p in cls.__dict__\n if isinstance(getattr(cls, p), (searchable_attribute, orderable_attribute))\n ]\n )\n", "path": "mlflow/entities/run_info.py" } ]	[ { "content": "from mlflow.entities.run_status import RunStatus\nfrom mlflow.entities._mlflow_object import _MLflowObject\nfrom mlflow.entities.lifecycle_stage import LifecycleStage\nfrom mlflow.exceptions import MlflowException\n\nfrom mlflow.protos.service_pb2 import RunInfo as ProtoRunInfo\nfrom mlflow.protos.databricks_pb2 import INVALID_PARAMETER_VALUE\n\n\ndef check_run_is_active(run_info):\n if run_info.lifecycle_stage != LifecycleStage.ACTIVE:\n raise MlflowException(\n \"The run {} must be in 'active' lifecycle_stage.\".format(run_info.run_id),\n error_code=INVALID_PARAMETER_VALUE,\n )\n\n\nclass searchable_attribute(property):\n # Wrapper class over property to designate some of the properties as searchable\n # run attributes\n pass\n\n\nclass orderable_attribute(property):\n # Wrapper class over property to designate some of the properties as orderable\n # run attributes\n pass\n\n\nclass RunInfo(_MLflowObject):\n \"\"\"\n Metadata about a run.\n \"\"\"\n\n def __init__(\n self,\n run_uuid,\n experiment_id,\n user_id,\n status,\n start_time,\n end_time,\n lifecycle_stage,\n artifact_uri=None,\n run_id=None,\n run_name=None,\n ):\n if experiment_id is None:\n raise Exception(\"experiment_id cannot be None\")\n if user_id is None:\n raise Exception(\"user_id cannot be None\")\n if status is None:\n raise Exception(\"status cannot be None\")\n if start_time is None:\n raise Exception(\"start_time cannot be None\")\n actual_run_id = run_id or run_uuid\n if actual_run_id is None:\n raise Exception(\"run_id and run_uuid cannot both be None\")\n self._run_uuid = actual_run_id\n self._run_id = actual_run_id\n self._experiment_id = experiment_id\n self._user_id = user_id\n self._status = status\n self._start_time = start_time\n self._end_time = end_time\n self._lifecycle_stage = lifecycle_stage\n self._artifact_uri = artifact_uri\n self._run_name = run_name\n\n def __eq__(self, other):\n if type(other) is type(self):\n # TODO deep equality here?\n return self.__dict__ == other.__dict__\n return False\n\n def _copy_with_overrides(self, status=None, end_time=None, lifecycle_stage=None, run_name=None):\n \"\"\"A copy of the RunInfo with certain attributes modified.\"\"\"\n proto = self.to_proto()\n if status:\n proto.status = status\n if end_time:\n proto.end_time = end_time\n if lifecycle_stage:\n proto.lifecycle_stage = lifecycle_stage\n if run_name:\n proto.run_name = run_name\n return RunInfo.from_proto(proto)\n\n @property\n def run_uuid(self):\n \"\"\"[Deprecated, use run_id instead] String containing run UUID.\"\"\"\n return self._run_uuid\n\n @property\n def run_id(self):\n \"\"\"String containing run id.\"\"\"\n return self._run_id\n\n @property\n def experiment_id(self):\n \"\"\"String ID of the experiment for the current run.\"\"\"\n return self._experiment_id\n\n @property\n def run_name(self):\n \"\"\"String containing run name.\"\"\"\n return self._run_name\n\n def _set_run_name(self, new_name):\n self._run_name = new_name\n\n @searchable_attribute\n def user_id(self):\n \"\"\"String ID of the user who initiated this run.\"\"\"\n return self._user_id\n\n @searchable_attribute\n def status(self):\n \"\"\"\n One of the values in :py:class:`mlflow.entities.RunStatus`\n describing the status of the run.\n \"\"\"\n return self._status\n\n @searchable_attribute\n def start_time(self):\n \"\"\"Start time of the run, in number of milliseconds since the UNIX epoch.\"\"\"\n return self._start_time\n\n @searchable_attribute\n def end_time(self):\n \"\"\"End time of the run, in number of milliseconds since the UNIX epoch.\"\"\"\n return self._end_time\n\n @searchable_attribute\n def artifact_uri(self):\n \"\"\"String root artifact URI of the run.\"\"\"\n return self._artifact_uri\n\n @property\n def lifecycle_stage(self):\n return self._lifecycle_stage\n\n def to_proto(self):\n proto = ProtoRunInfo()\n proto.run_uuid = self.run_uuid\n proto.run_id = self.run_id\n if self.run_name is not None:\n proto.run_name = self.run_name\n proto.experiment_id = self.experiment_id\n proto.user_id = self.user_id\n proto.status = RunStatus.from_string(self.status)\n proto.start_time = self.start_time\n if self.end_time:\n proto.end_time = self.end_time\n if self.artifact_uri:\n proto.artifact_uri = self.artifact_uri\n proto.lifecycle_stage = self.lifecycle_stage\n return proto\n\n @classmethod\n def from_proto(cls, proto):\n end_time = proto.end_time\n # The proto2 default scalar value of zero indicates that the run's end time is absent.\n # An absent end time is represented with a NoneType in the `RunInfo` class\n if end_time == 0:\n end_time = None\n return cls(\n run_uuid=proto.run_uuid,\n run_id=proto.run_id,\n run_name=proto.run_name,\n experiment_id=proto.experiment_id,\n user_id=proto.user_id,\n status=RunStatus.to_string(proto.status),\n start_time=proto.start_time,\n end_time=end_time,\n lifecycle_stage=proto.lifecycle_stage,\n artifact_uri=proto.artifact_uri,\n )\n\n @classmethod\n def get_searchable_attributes(cls):\n return sorted(\n [p for p in cls.__dict__ if isinstance(getattr(cls, p), searchable_attribute)]\n )\n\n @classmethod\n def get_orderable_attributes(cls):\n # Note that all searchable attributes are also orderable.\n return sorted(\n [\n p\n for p in cls.__dict__\n if isinstance(getattr(cls, p), (searchable_attribute, orderable_attribute))\n ]\n )\n", "path": "mlflow/entities/run_info.py" } ]	diff --git a/docs/source/search-runs.rst b/docs/source/search-runs.rst index feb99aa7e4c92..ff5e57f7e306e 100644 --- a/docs/source/search-runs.rst +++ b/docs/source/search-runs.rst @@ -86,7 +86,7 @@ that have a leading number. If an entity name contains a leading number, enclose Run Attributes ~~~~~~~~~~~~~~ -You can search using the following run attributes contained in :py:class:`mlflow.entities.RunInfo`: ``status``, ``artifact_uri``, ``start_time`` and ``end_time``. The ``status`` and ``artifact_uri`` attributes have string values, while ``start_time`` and ``end_time`` are numeric. Other fields in ``mlflow.entities.RunInfo`` are not searchable. +You can search using the following run attributes contained in :py:class:`mlflow.entities.RunInfo`: ``status``, ``artifact_uri``, ``user_id``, ``start_time`` and ``end_time``. The ``status``, ``user_id`` and ``artifact_uri`` attributes have string values, while ``start_time`` and ``end_time`` are numeric. Other fields in ``mlflow.entities.RunInfo`` are not searchable. .. note:: @@ -102,6 +102,7 @@ You can search using the following run attributes contained in :py:class:`mlflow # RHS value for start_time and end_time are unix timestamp attributes.start_time >= 1664067852747 attributes.end_time < 1664067852747 + attributes.user_id = 'user1' .. _mlflow_tags: diff --git a/mlflow/entities/run_info.py b/mlflow/entities/run_info.py index c219a72f76feb..7f6ef6b826a5c 100644 --- a/mlflow/entities/run_info.py +++ b/mlflow/entities/run_info.py @@ -109,7 +109,7 @@ def run_name(self): def _set_run_name(self, new_name): self._run_name = new_name - @property + @searchable_attribute def user_id(self): """String ID of the user who initiated this run.""" return self._user_id diff --git a/tests/entities/test_run_info.py b/tests/entities/test_run_info.py index 0b6d3ac5ba3f2..0e3bd9945aef3 100644 --- a/tests/entities/test_run_info.py +++ b/tests/entities/test_run_info.py @@ -147,6 +147,6 @@ def test_creation_and_hydration(self): def test_searchable_attributes(self): self.assertSequenceEqual( - {"status", "artifact_uri", "start_time", "end_time"}, + {"status", "artifact_uri", "start_time", "user_id", "end_time"}, set(RunInfo.get_searchable_attributes()), ) diff --git a/tests/store/tracking/test_sqlalchemy_store.py b/tests/store/tracking/test_sqlalchemy_store.py index 5d3fe1a00e439..07160319b964c 100644 --- a/tests/store/tracking/test_sqlalchemy_store.py +++ b/tests/store/tracking/test_sqlalchemy_store.py @@ -2450,7 +2450,7 @@ def test_get_attribute_name(): # we want this to break if a searchable or orderable attribute has been added # and not referred to in this test # searchable attributes are also orderable - assert len(entities.RunInfo.get_orderable_attributes()) == 4 + assert len(entities.RunInfo.get_orderable_attributes()) == 5 def test_get_orderby_clauses(): diff --git a/tests/utils/test_search_utils.py b/tests/utils/test_search_utils.py index 9d75d68d0d7ae..fcede983cf642 100644 --- a/tests/utils/test_search_utils.py +++ b/tests/utils/test_search_utils.py @@ -322,6 +322,38 @@ def test_filter_runs_by_start_time(): assert SearchUtils.filter(runs, "attribute.start_time = 2") == runs[2:] +def test_filter_runs_by_user_id(): + runs = [ + Run( + run_info=RunInfo( + run_uuid="a", + run_id="a", + experiment_id=0, + user_id="user-id", + status=RunStatus.to_string(RunStatus.FINISHED), + start_time=1, + end_time=1, + lifecycle_stage=LifecycleStage.ACTIVE, + ), + run_data=RunData(), + ), + Run( + run_info=RunInfo( + run_uuid="b", + run_id="b", + experiment_id=0, + user_id="user-id2", + status=RunStatus.to_string(RunStatus.FINISHED), + start_time=1, + end_time=1, + lifecycle_stage=LifecycleStage.ACTIVE, + ), + run_data=RunData(), + ), + ] + assert SearchUtils.filter(runs, "attribute.user_id = 'user-id2'")[0] == runs[1] + + def test_filter_runs_by_end_time(): runs = [ Run(
Gallopsled__pwntools-597	A little bug in Buffer class There is a litttle bug in pwnlib.tubes.Buffer class.The class method unget has a type error in line 117.add a buffer and a list ``` Traceback (most recent call last): File "<input>", line 1, in <module> a.unget(b) File "buffer.py", line 117, in unget self.data = data + self.data TypeError: unsupported operand type(s) for +: 'Buffer' and 'list' ```	[ { "content": "#!/usr/bin/env python2\n\nclass Buffer(Exception):\n \"\"\"\n List of strings with some helper routines.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"A\" * 10)\n >>> b.add(\"B\" * 10)\n >>> len(b)\n 20\n >>> b.get(1)\n 'A'\n >>> len(b)\n 19\n >>> b.get(9999)\n 'AAAAAAAAABBBBBBBBBB'\n >>> len(b)\n 0\n >>> b.get(1)\n ''\n\n Implementation Details:\n\n Implemented as a list. Strings are added onto the end.\n The ``0th`` item in the buffer is the oldest item, and\n will be received first.\n \"\"\"\n def __init__(self):\n self.data = [] # Buffer\n self.size = 0 # Length\n\n\n def __len__(self):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('lol')\n >>> len(b) == 3\n True\n >>> b.add('foobar')\n >>> len(b) == 9\n True\n \"\"\"\n return self.size\n\n def __nonzero__(self):\n return len(self) > 0\n\n def __contains__(self, x):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('asdf')\n >>> 'x' in b\n False\n >>> b.add('x')\n >>> 'x' in b\n True\n \"\"\"\n for b in self.data:\n if x in b:\n return True\n return False\n\n def index(self, x):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('asdf')\n >>> b.add('qwert')\n >>> b.index('t') == len(b) - 1\n True\n \"\"\"\n sofar = 0\n for b in self.data:\n if x in b:\n return sofar + b.index(x)\n sofar += len(b)\n raise IndexError()\n\n def add(self, data):\n \"\"\"\n Adds data to the buffer.\n\n Arguments:\n data(str,Buffer): Data to add\n \"\"\"\n # Fast path for ''\n if not data: return\n\n if isinstance(data, Buffer):\n self.size += data.size\n self.data += data.data\n else:\n self.size += len(data)\n self.data.append(data)\n\n def unget(self, data):\n \"\"\"\n Places data at the front of the buffer.\n\n Arguments:\n data(str,Buffer): Data to place at the beginning of the buffer.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"hello\")\n >>> b.add(\"world\")\n >>> b.get(5)\n 'hello'\n >>> b.unget(\"goodbye\")\n >>> b.get()\n 'goodbyeworld'\n \"\"\"\n if isinstance(data, Buffer):\n self.data = data + self.data\n self.size += data.size\n else:\n self.data.insert(0, data)\n self.size += len(data)\n\n def get(self, want=float('inf')):\n \"\"\"\n Retrieves bytes from the buffer.\n\n Arguments:\n want(int): Maximum number of bytes to fetch\n\n Returns:\n Data as string\n\n Example:\n\n >>> b = Buffer()\n >>> b.add('hello')\n >>> b.add('world')\n >>> b.get(1)\n 'h'\n >>> b.get()\n 'elloworld'\n \"\"\"\n # Fast path, get all of the data\n if want >= self.size:\n data = ''.join(self.data)\n self.size = 0\n self.data = []\n return data\n\n # Slow path, find the correct-index chunk\n have = 0\n i = 0\n while want >= have:\n have += len(self.data[i])\n i += 1\n\n # Join the chunks, evict from the buffer\n data = ''.join(self.data[:i])\n self.data = self.data[i:]\n\n # If the last chunk puts us over the limit,\n # stick the extra back at the beginning.\n if have > want:\n extra = data[want:]\n data = data[:want]\n self.data.insert(0, extra)\n\n # Size update\n self.size -= len(data)\n\n return data\n", "path": "pwnlib/tubes/buffer.py" } ]	[ { "content": "#!/usr/bin/env python2\n\nclass Buffer(Exception):\n \"\"\"\n List of strings with some helper routines.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"A\" * 10)\n >>> b.add(\"B\" * 10)\n >>> len(b)\n 20\n >>> b.get(1)\n 'A'\n >>> len(b)\n 19\n >>> b.get(9999)\n 'AAAAAAAAABBBBBBBBBB'\n >>> len(b)\n 0\n >>> b.get(1)\n ''\n\n Implementation Details:\n\n Implemented as a list. Strings are added onto the end.\n The ``0th`` item in the buffer is the oldest item, and\n will be received first.\n \"\"\"\n def __init__(self):\n self.data = [] # Buffer\n self.size = 0 # Length\n\n\n def __len__(self):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('lol')\n >>> len(b) == 3\n True\n >>> b.add('foobar')\n >>> len(b) == 9\n True\n \"\"\"\n return self.size\n\n def __nonzero__(self):\n return len(self) > 0\n\n def __contains__(self, x):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('asdf')\n >>> 'x' in b\n False\n >>> b.add('x')\n >>> 'x' in b\n True\n \"\"\"\n for b in self.data:\n if x in b:\n return True\n return False\n\n def index(self, x):\n \"\"\"\n >>> b = Buffer()\n >>> b.add('asdf')\n >>> b.add('qwert')\n >>> b.index('t') == len(b) - 1\n True\n \"\"\"\n sofar = 0\n for b in self.data:\n if x in b:\n return sofar + b.index(x)\n sofar += len(b)\n raise IndexError()\n\n def add(self, data):\n \"\"\"\n Adds data to the buffer.\n\n Arguments:\n data(str,Buffer): Data to add\n \"\"\"\n # Fast path for ''\n if not data: return\n\n if isinstance(data, Buffer):\n self.size += data.size\n self.data += data.data\n else:\n self.size += len(data)\n self.data.append(data)\n\n def unget(self, data):\n \"\"\"\n Places data at the front of the buffer.\n\n Arguments:\n data(str,Buffer): Data to place at the beginning of the buffer.\n\n Example:\n\n >>> b = Buffer()\n >>> b.add(\"hello\")\n >>> b.add(\"world\")\n >>> b.get(5)\n 'hello'\n >>> b.unget(\"goodbye\")\n >>> b.get()\n 'goodbyeworld'\n \"\"\"\n if isinstance(data, Buffer):\n self.data = data.data + self.data\n self.size += data.size\n else:\n self.data.insert(0, data)\n self.size += len(data)\n\n def get(self, want=float('inf')):\n \"\"\"\n Retrieves bytes from the buffer.\n\n Arguments:\n want(int): Maximum number of bytes to fetch\n\n Returns:\n Data as string\n\n Example:\n\n >>> b = Buffer()\n >>> b.add('hello')\n >>> b.add('world')\n >>> b.get(1)\n 'h'\n >>> b.get()\n 'elloworld'\n \"\"\"\n # Fast path, get all of the data\n if want >= self.size:\n data = ''.join(self.data)\n self.size = 0\n self.data = []\n return data\n\n # Slow path, find the correct-index chunk\n have = 0\n i = 0\n while want >= have:\n have += len(self.data[i])\n i += 1\n\n # Join the chunks, evict from the buffer\n data = ''.join(self.data[:i])\n self.data = self.data[i:]\n\n # If the last chunk puts us over the limit,\n # stick the extra back at the beginning.\n if have > want:\n extra = data[want:]\n data = data[:want]\n self.data.insert(0, extra)\n\n # Size update\n self.size -= len(data)\n\n return data\n", "path": "pwnlib/tubes/buffer.py" } ]	diff --git a/pwnlib/tubes/buffer.py b/pwnlib/tubes/buffer.py index 199dcebfd..305d7e1b4 100644 --- a/pwnlib/tubes/buffer.py +++ b/pwnlib/tubes/buffer.py @@ -114,7 +114,7 @@ def unget(self, data): 'goodbyeworld' """ if isinstance(data, Buffer): - self.data = data + self.data + self.data = data.data + self.data self.size += data.size else: self.data.insert(0, data)
pyinstaller__pyinstaller-5778	Problem with scikitimage and _rolling_ball_cy Hello Everyone, When I run exe file on my computer everything works ok but when I try to run on virtual machine I get the error File "skimage\restoration\rolling_ball.py", line 3, in <module> ImportError: DLL load failed while importing _rolling_ball_cy: The specified module could not be found. [2244] Failed to execute script Diopomat I was trying to add by --hidden-import --hidden-import "skimage.restoration._rolling_ball_cy" I have spent a couple of hours to resolve this problem but I had to give up :( Please help me, how to fix it. Best regards Pavel	[ { "content": "#-----------------------------------------------------------------------------\n# Copyright (c) 2013-2021, PyInstaller Development Team.\n#\n# Distributed under the terms of the GNU General Public License (version 2\n# or later) with exception for distributing the bootloader.\n#\n# The full license is in the file COPYING.txt, distributed with this software.\n#\n# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)\n#-----------------------------------------------------------------------------\n\n\n\"\"\"\nManipulating with dynamic libraries.\n\"\"\"\n\nimport os.path\n\nfrom PyInstaller.utils.win32 import winutils\n\n\n__all__ = ['exclude_list', 'include_list', 'include_library']\n\n\nimport os\nimport re\n\n\nfrom PyInstaller.compat import is_win, is_unix, is_aix, is_darwin\n\n\nimport PyInstaller.log as logging\nlogger = logging.getLogger(__name__)\n\n\n_BOOTLOADER_FNAMES = {'run', 'run_d', 'runw', 'runw_d'}\n\n\n# Ignoring some system libraries speeds up packaging process\n_excludes = {\n # Ignore annoying warnings with Windows system DLLs.\n #\n # 'W: library kernel32.dll required via ctypes not found'\n # 'W: library coredll.dll required via ctypes not found'\n #\n # These these dlls has to be ignored for all operating systems\n # because they might be resolved when scanning code for ctypes\n # dependencies.\n r'advapi32\\.dll',\n r'ws2_32\\.dll',\n r'gdi32\\.dll',\n r'oleaut32\\.dll',\n r'shell32\\.dll',\n r'ole32\\.dll',\n\n r'coredll\\.dll',\n r'crypt32\\.dll',\n r'kernel32',\n r'kernel32\\.dll',\n r'msvcrt\\.dll',\n r'rpcrt4\\.dll',\n r'user32\\.dll',\n # Some modules tries to import the Python library.\n # e.g. pyreadline.console.console\n r'python\\%s\\%s',\n}\n\n# Regex includes - overrides excludes.\n# Include list is used only to override specific libraries\n# from exclude list.\n_includes = set()\n\n\n_win_includes = {\n # DLLs are from 'Microsoft Visual C++ 2010 Redistributable Package'.\n # http://msdn.microsoft.com/en-us/library/8kche8ah(v=vs.100).aspx\n #\n # Python 3.3 and 3.4 depends use Visual Studio C++ 2010 for Windows builds.\n # python33.dll depends on msvcr100.dll.\n #\n # Visual Studio C++ 2010 does not need Assembly manifests anymore and\n # uses C++ runtime libraries the old way - pointing to C:\\Windows\\System32.\n # It is necessary to allow inclusion of these libraries from\n # C:\\Windows\\System32.\n r'atl100\\.dll',\n r'msvcr100\\.dll',\n r'msvcp100\\.dll',\n r'mfc100\\.dll',\n r'mfc100u\\.dll',\n r'mfcmifc80\\.dll',\n r'mfcm100\\.dll',\n r'mfcm100u\\.dll',\n\n # Python 3.5 uses the Univeral C Runtime which consists of these DLLs:\n r'api-ms-win-core.',\n r'api-ms-win-crt.',\n r'ucrtbase\\.dll',\n r'vcruntime140\\.dll',\n\n # Additional DLLs from VC 2015/2017/2019 runtime. Allow these to be\n # collected to avoid missing-DLL errors when the target machine does\n # not have the VC redistributable installed.\n r'msvcp140\\.dll',\n r'msvcp140_1\\.dll',\n r'msvcp140_2\\.dll',\n r'vcruntime140_1\\.dll',\n\n # Allow pythonNN.dll, pythoncomNN.dll, pywintypesNN.dll\n r'py(?:thon(?:com(?:loader)?)?\|wintypes)\\d+\\.dll',\n}\n\n_win_excludes = {\n # On Windows, only .dll files can be loaded.\n r'.\\.so',\n r'.\\.dylib',\n\n # MS assembly excludes\n r'Microsoft\\.Windows\\.Common-Controls',\n}\n\n\n_unix_excludes = {\n r'libc\\.so(\\..)?',\n r'libdl\\.so(\\..)?',\n r'libm\\.so(\\..)?',\n r'libpthread\\.so(\\..)?',\n r'librt\\.so(\\..)?',\n r'libthread_db\\.so(\\..)?',\n # glibc regex excludes.\n r'ld-linux\\.so(\\..)?',\n r'libBrokenLocale\\.so(\\..)?',\n r'libanl\\.so(\\..)?',\n r'libcidn\\.so(\\..)?',\n r'libcrypt\\.so(\\..)?',\n r'libnsl\\.so(\\..)?',\n r'libnss_compat.\\.so(\\..)?',\n r'libnss_dns.\\.so(\\..)?',\n r'libnss_files.\\.so(\\..)?',\n r'libnss_hesiod.\\.so(\\..)?',\n r'libnss_nis.\\.so(\\..)?',\n r'libnss_nisplus.\\.so(\\..)?',\n r'libresolv\\.so(\\..)?',\n r'libutil\\.so(\\..)?',\n # graphical interface libraries come with graphical stack (see libglvnd)\n r'libE?(Open)?GLX?(ESv1_CM\|ESv2)?(dispatch)?\\.so(\\..)?',\n r'libdrm\\.so(\\..)?',\n # libxcb-dri changes ABI frequently (e.g.: between Ubuntu LTS releases) and\n # is usually installed as dependency of the graphics stack anyway. No need\n # to bundle it.\n r'libxcb\\.so(\\..)?',\n r'libxcb-dri.\\.so(\\..)?',\n}\n\n_aix_excludes = {\n r'libbz2\\.a',\n r'libc\\.a',\n r'libC\\.a',\n r'libcrypt\\.a',\n r'libdl\\.a',\n r'libintl\\.a',\n r'libpthreads\\.a',\n r'librt\\\\.a',\n r'librtl\\.a',\n r'libz\\.a',\n}\n\n\nif is_win:\n _includes \|= _win_includes\n _excludes \|= _win_excludes\nelif is_aix:\n # The exclude list for AIX differs from other nix platforms.\n _excludes \|= _aix_excludes\nelif is_unix:\n # Common excludes for nix platforms -- except AIX.\n _excludes \|= _unix_excludes\n\n\nclass ExcludeList(object):\n def __init__(self):\n self.regex = re.compile('\|'.join(_excludes), re.I)\n\n def search(self, libname):\n # Running re.search() on '' regex never returns None.\n if _excludes:\n return self.regex.match(os.path.basename(libname))\n else:\n return False\n\n\nclass IncludeList(object):\n def __init__(self):\n self.regex = re.compile('\|'.join(_includes), re.I)\n\n def search(self, libname):\n # Running re.search() on '' regex never returns None.\n if _includes:\n return self.regex.match(os.path.basename(libname))\n else:\n return False\n\n\nexclude_list = ExcludeList()\ninclude_list = IncludeList()\n\n\nif is_darwin:\n # On Mac use macholib to decide if a binary is a system one.\n from macholib import util\n\n class MacExcludeList(object):\n def __init__(self, global_exclude_list):\n # Wraps the global 'exclude_list' before it is overriden\n # by this class.\n self._exclude_list = global_exclude_list\n\n def search(self, libname):\n # First try global exclude list. If it matches then\n # return it's result otherwise continue with other check.\n result = self._exclude_list.search(libname)\n if result:\n return result\n else:\n return util.in_system_path(libname)\n\n exclude_list = MacExcludeList(exclude_list)\n\nelif is_win:\n class WinExcludeList(object):\n def __init__(self, global_exclude_list):\n self._exclude_list = global_exclude_list\n # use normpath because msys2 uses / instead of \\\n self._windows_dir = os.path.normpath(\n winutils.get_windows_dir().lower()\n )\n\n def search(self, libname):\n libname = libname.lower()\n result = self._exclude_list.search(libname)\n if result:\n return result\n else:\n # Exclude everything from the Windows directory by default.\n # .. sometimes realpath changes the case of libname, lower it\n # .. use normpath because msys2 uses / instead of \\\n fn = os.path.normpath(os.path.realpath(libname).lower())\n return fn.startswith(self._windows_dir)\n\n exclude_list = WinExcludeList(exclude_list)\n\n\ndef include_library(libname):\n \"\"\"\n Check if a dynamic library should be included with application or not.\n \"\"\"\n # For configuration phase we need to have exclude / include lists None\n # so these checking is skipped and library gets included.\n if exclude_list:\n if exclude_list.search(libname) and not include_list.search(libname):\n # Library is excluded and is not overriden by include list.\n # It should be then excluded.\n return False\n else:\n # Include library\n return True\n else:\n # By default include library.\n return True\n\n\ndef mac_set_relative_dylib_deps(libname, distname):\n \"\"\"\n On Mac OS X set relative paths to dynamic library dependencies\n of `libname`.\n\n Relative paths allow to avoid using environment variable DYLD_LIBRARY_PATH.\n There are known some issues with DYLD_LIBRARY_PATH. Relative paths is\n more flexible mechanism.\n\n Current location of dependend libraries is derived from the location\n of the library path (paths start with '@loader_path').\n\n 'distname' path of the library relative to dist directory of frozen\n executable. We need this to determine the level of directory\n level for @loader_path of binaries not found in dist directory.\n\n E.g. qt4 plugins are not in the same directory as Qt.dylib\n files. Without using '@loader_path/../..' for qt plugins\n Mac OS X would not be able to resolve shared library\n dependencies and qt plugins will not be loaded.\n \"\"\"\n\n from macholib import util\n from macholib.MachO import MachO\n\n # Ignore bootloader otherwise PyInstaller fails with exception like\n # 'ValueError: total_size > low_offset (288 > 0)'\n if os.path.basename(libname) in _BOOTLOADER_FNAMES:\n return\n\n # Determine how many directories up is the directory with shared\n # dynamic libraries. '../'\n # E.g. ./qt4_plugins/images/ -> ./../../\n parent_dir = ''\n # Check if distname is not only base filename.\n if os.path.dirname(distname):\n parent_level = len(os.path.dirname(distname).split(os.sep))\n parent_dir = parent_level * (os.pardir + os.sep)\n\n def match_func(pth):\n \"\"\"\n For system libraries is still used absolute path. It is unchanged.\n \"\"\"\n # Leave system dynamic libraries unchanged\n if util.in_system_path(pth):\n return None\n\n # The older python.org builds that use system Tcl/Tk framework\n # have their _tkinter.cpython-*-darwin.so library linked against\n # /Library/Frameworks/Tcl.framework/Versions/8.5/Tcl and\n # /Library/Frameworks/Tk.framework/Versions/8.5/Tk, although the\n # actual frameworks are located in /System/Library/Frameworks.\n # Therefore, they slip through the above in_system_path() check,\n # and we need to exempt them manually.\n _exemptions = [\n '/Library/Frameworks/Tcl.framework/',\n '/Library/Frameworks/Tk.framework/'\n ]\n if any([x in pth for x in _exemptions]):\n return None\n\n # Use relative path to dependent dynamic libraries based on the\n # location of the executable.\n return os.path.join('@loader_path', parent_dir, os.path.basename(pth))\n\n # Rewrite mach headers with @loader_path.\n dll = MachO(libname)\n dll.rewriteLoadCommands(match_func)\n\n # Write changes into file.\n # Write code is based on macholib example.\n try:\n with open(dll.filename, 'rb+') as f:\n for header in dll.headers:\n f.seek(0)\n dll.write(f)\n f.seek(0, 2)\n f.flush()\n except Exception:\n pass\n\n\ndef mac_is_binary_signed(filename):\n \"\"\"\n Check if the given macOS binary file is signed.\n \"\"\"\n from macholib.MachO import MachO\n from macholib import mach_o # constants\n\n # Open the file\n try:\n m = MachO(filename)\n except Exception:\n return False\n\n # Walk over all headers and check if any contains LC_CODE_SIGNATURE\n # load command\n for header in m.headers:\n for cmd in header.commands:\n if cmd[0].cmd == mach_o.LC_CODE_SIGNATURE:\n return True\n return False\n\n\ndef mac_strip_signature(libname, distname):\n \"\"\"\n On macOS, strip away the signature from the binary file. As we may\n not be collecting all components from a signed framework bundle, the\n collection may invalidate the existing signature on a collected\n shared library, which will prevent the latter from being loaded.\n \"\"\"\n from ..compat import exec_command_rc\n\n # For now, limit this only to Python shared library. Other shared\n # library files from Python.framework bundle also seem to be signed,\n # but their signature is not invalidated by partial collection like\n # it is for Python library...\n if os.path.basename(libname) != 'Python':\n return\n if not mac_is_binary_signed(libname):\n return\n # Run codesign --remove-signature libname\n try:\n logger.debug(\"Removing signature from %s\", libname)\n result = exec_command_rc('codesign', '--remove-signature', libname)\n except Exception as e:\n logger.warning(\n \"Failed to run 'codesign' to remove signature from %s: %r\",\n libname, e)\n return\n if result != 0:\n logger.warning(\n \"'codesign --remove-signature %s' returned non-zero status %d\",\n libname, result)\n", "path": "PyInstaller/depend/dylib.py" } ]	[ { "content": "#-----------------------------------------------------------------------------\n# Copyright (c) 2013-2021, PyInstaller Development Team.\n#\n# Distributed under the terms of the GNU General Public License (version 2\n# or later) with exception for distributing the bootloader.\n#\n# The full license is in the file COPYING.txt, distributed with this software.\n#\n# SPDX-License-Identifier: (GPL-2.0-or-later WITH Bootloader-exception)\n#-----------------------------------------------------------------------------\n\n\n\"\"\"\nManipulating with dynamic libraries.\n\"\"\"\n\nimport os.path\n\nfrom PyInstaller.utils.win32 import winutils\n\n\n__all__ = ['exclude_list', 'include_list', 'include_library']\n\n\nimport os\nimport re\n\n\nfrom PyInstaller.compat import is_win, is_unix, is_aix, is_darwin\n\n\nimport PyInstaller.log as logging\nlogger = logging.getLogger(__name__)\n\n\n_BOOTLOADER_FNAMES = {'run', 'run_d', 'runw', 'runw_d'}\n\n\n# Ignoring some system libraries speeds up packaging process\n_excludes = {\n # Ignore annoying warnings with Windows system DLLs.\n #\n # 'W: library kernel32.dll required via ctypes not found'\n # 'W: library coredll.dll required via ctypes not found'\n #\n # These these dlls has to be ignored for all operating systems\n # because they might be resolved when scanning code for ctypes\n # dependencies.\n r'advapi32\\.dll',\n r'ws2_32\\.dll',\n r'gdi32\\.dll',\n r'oleaut32\\.dll',\n r'shell32\\.dll',\n r'ole32\\.dll',\n\n r'coredll\\.dll',\n r'crypt32\\.dll',\n r'kernel32',\n r'kernel32\\.dll',\n r'msvcrt\\.dll',\n r'rpcrt4\\.dll',\n r'user32\\.dll',\n # Some modules tries to import the Python library.\n # e.g. pyreadline.console.console\n r'python\\%s\\%s',\n}\n\n# Regex includes - overrides excludes.\n# Include list is used only to override specific libraries\n# from exclude list.\n_includes = set()\n\n\n_win_includes = {\n # DLLs are from 'Microsoft Visual C++ 2010 Redistributable Package'.\n # http://msdn.microsoft.com/en-us/library/8kche8ah(v=vs.100).aspx\n #\n # Python 3.3 and 3.4 depends use Visual Studio C++ 2010 for Windows builds.\n # python33.dll depends on msvcr100.dll.\n #\n # Visual Studio C++ 2010 does not need Assembly manifests anymore and\n # uses C++ runtime libraries the old way - pointing to C:\\Windows\\System32.\n # It is necessary to allow inclusion of these libraries from\n # C:\\Windows\\System32.\n r'atl100\\.dll',\n r'msvcr100\\.dll',\n r'msvcp100\\.dll',\n r'mfc100\\.dll',\n r'mfc100u\\.dll',\n r'mfcmifc80\\.dll',\n r'mfcm100\\.dll',\n r'mfcm100u\\.dll',\n\n # Python 3.5 uses the Univeral C Runtime which consists of these DLLs:\n r'api-ms-win-core.',\n r'api-ms-win-crt.',\n r'ucrtbase\\.dll',\n r'vcruntime140\\.dll',\n\n # Additional DLLs from VC 2015/2017/2019 runtime. Allow these to be\n # collected to avoid missing-DLL errors when the target machine does\n # not have the VC redistributable installed.\n r'msvcp140\\.dll',\n r'msvcp140_1\\.dll',\n r'msvcp140_2\\.dll',\n r'vcruntime140_1\\.dll',\n r'vcomp140\\.dll',\n\n # Allow pythonNN.dll, pythoncomNN.dll, pywintypesNN.dll\n r'py(?:thon(?:com(?:loader)?)?\|wintypes)\\d+\\.dll',\n}\n\n_win_excludes = {\n # On Windows, only .dll files can be loaded.\n r'.\\.so',\n r'.\\.dylib',\n\n # MS assembly excludes\n r'Microsoft\\.Windows\\.Common-Controls',\n}\n\n\n_unix_excludes = {\n r'libc\\.so(\\..)?',\n r'libdl\\.so(\\..)?',\n r'libm\\.so(\\..)?',\n r'libpthread\\.so(\\..)?',\n r'librt\\.so(\\..)?',\n r'libthread_db\\.so(\\..)?',\n # glibc regex excludes.\n r'ld-linux\\.so(\\..)?',\n r'libBrokenLocale\\.so(\\..)?',\n r'libanl\\.so(\\..)?',\n r'libcidn\\.so(\\..)?',\n r'libcrypt\\.so(\\..)?',\n r'libnsl\\.so(\\..)?',\n r'libnss_compat.\\.so(\\..)?',\n r'libnss_dns.\\.so(\\..)?',\n r'libnss_files.\\.so(\\..)?',\n r'libnss_hesiod.\\.so(\\..)?',\n r'libnss_nis.\\.so(\\..)?',\n r'libnss_nisplus.\\.so(\\..)?',\n r'libresolv\\.so(\\..)?',\n r'libutil\\.so(\\..)?',\n # graphical interface libraries come with graphical stack (see libglvnd)\n r'libE?(Open)?GLX?(ESv1_CM\|ESv2)?(dispatch)?\\.so(\\..)?',\n r'libdrm\\.so(\\..)?',\n # libxcb-dri changes ABI frequently (e.g.: between Ubuntu LTS releases) and\n # is usually installed as dependency of the graphics stack anyway. No need\n # to bundle it.\n r'libxcb\\.so(\\..)?',\n r'libxcb-dri.\\.so(\\..)?',\n}\n\n_aix_excludes = {\n r'libbz2\\.a',\n r'libc\\.a',\n r'libC\\.a',\n r'libcrypt\\.a',\n r'libdl\\.a',\n r'libintl\\.a',\n r'libpthreads\\.a',\n r'librt\\\\.a',\n r'librtl\\.a',\n r'libz\\.a',\n}\n\n\nif is_win:\n _includes \|= _win_includes\n _excludes \|= _win_excludes\nelif is_aix:\n # The exclude list for AIX differs from other nix platforms.\n _excludes \|= _aix_excludes\nelif is_unix:\n # Common excludes for nix platforms -- except AIX.\n _excludes \|= _unix_excludes\n\n\nclass ExcludeList(object):\n def __init__(self):\n self.regex = re.compile('\|'.join(_excludes), re.I)\n\n def search(self, libname):\n # Running re.search() on '' regex never returns None.\n if _excludes:\n return self.regex.match(os.path.basename(libname))\n else:\n return False\n\n\nclass IncludeList(object):\n def __init__(self):\n self.regex = re.compile('\|'.join(_includes), re.I)\n\n def search(self, libname):\n # Running re.search() on '' regex never returns None.\n if _includes:\n return self.regex.match(os.path.basename(libname))\n else:\n return False\n\n\nexclude_list = ExcludeList()\ninclude_list = IncludeList()\n\n\nif is_darwin:\n # On Mac use macholib to decide if a binary is a system one.\n from macholib import util\n\n class MacExcludeList(object):\n def __init__(self, global_exclude_list):\n # Wraps the global 'exclude_list' before it is overriden\n # by this class.\n self._exclude_list = global_exclude_list\n\n def search(self, libname):\n # First try global exclude list. If it matches then\n # return it's result otherwise continue with other check.\n result = self._exclude_list.search(libname)\n if result:\n return result\n else:\n return util.in_system_path(libname)\n\n exclude_list = MacExcludeList(exclude_list)\n\nelif is_win:\n class WinExcludeList(object):\n def __init__(self, global_exclude_list):\n self._exclude_list = global_exclude_list\n # use normpath because msys2 uses / instead of \\\n self._windows_dir = os.path.normpath(\n winutils.get_windows_dir().lower()\n )\n\n def search(self, libname):\n libname = libname.lower()\n result = self._exclude_list.search(libname)\n if result:\n return result\n else:\n # Exclude everything from the Windows directory by default.\n # .. sometimes realpath changes the case of libname, lower it\n # .. use normpath because msys2 uses / instead of \\\n fn = os.path.normpath(os.path.realpath(libname).lower())\n return fn.startswith(self._windows_dir)\n\n exclude_list = WinExcludeList(exclude_list)\n\n\ndef include_library(libname):\n \"\"\"\n Check if a dynamic library should be included with application or not.\n \"\"\"\n # For configuration phase we need to have exclude / include lists None\n # so these checking is skipped and library gets included.\n if exclude_list:\n if exclude_list.search(libname) and not include_list.search(libname):\n # Library is excluded and is not overriden by include list.\n # It should be then excluded.\n return False\n else:\n # Include library\n return True\n else:\n # By default include library.\n return True\n\n\ndef mac_set_relative_dylib_deps(libname, distname):\n \"\"\"\n On Mac OS X set relative paths to dynamic library dependencies\n of `libname`.\n\n Relative paths allow to avoid using environment variable DYLD_LIBRARY_PATH.\n There are known some issues with DYLD_LIBRARY_PATH. Relative paths is\n more flexible mechanism.\n\n Current location of dependend libraries is derived from the location\n of the library path (paths start with '@loader_path').\n\n 'distname' path of the library relative to dist directory of frozen\n executable. We need this to determine the level of directory\n level for @loader_path of binaries not found in dist directory.\n\n E.g. qt4 plugins are not in the same directory as Qt.dylib\n files. Without using '@loader_path/../..' for qt plugins\n Mac OS X would not be able to resolve shared library\n dependencies and qt plugins will not be loaded.\n \"\"\"\n\n from macholib import util\n from macholib.MachO import MachO\n\n # Ignore bootloader otherwise PyInstaller fails with exception like\n # 'ValueError: total_size > low_offset (288 > 0)'\n if os.path.basename(libname) in _BOOTLOADER_FNAMES:\n return\n\n # Determine how many directories up is the directory with shared\n # dynamic libraries. '../'\n # E.g. ./qt4_plugins/images/ -> ./../../\n parent_dir = ''\n # Check if distname is not only base filename.\n if os.path.dirname(distname):\n parent_level = len(os.path.dirname(distname).split(os.sep))\n parent_dir = parent_level * (os.pardir + os.sep)\n\n def match_func(pth):\n \"\"\"\n For system libraries is still used absolute path. It is unchanged.\n \"\"\"\n # Leave system dynamic libraries unchanged\n if util.in_system_path(pth):\n return None\n\n # The older python.org builds that use system Tcl/Tk framework\n # have their _tkinter.cpython-*-darwin.so library linked against\n # /Library/Frameworks/Tcl.framework/Versions/8.5/Tcl and\n # /Library/Frameworks/Tk.framework/Versions/8.5/Tk, although the\n # actual frameworks are located in /System/Library/Frameworks.\n # Therefore, they slip through the above in_system_path() check,\n # and we need to exempt them manually.\n _exemptions = [\n '/Library/Frameworks/Tcl.framework/',\n '/Library/Frameworks/Tk.framework/'\n ]\n if any([x in pth for x in _exemptions]):\n return None\n\n # Use relative path to dependent dynamic libraries based on the\n # location of the executable.\n return os.path.join('@loader_path', parent_dir, os.path.basename(pth))\n\n # Rewrite mach headers with @loader_path.\n dll = MachO(libname)\n dll.rewriteLoadCommands(match_func)\n\n # Write changes into file.\n # Write code is based on macholib example.\n try:\n with open(dll.filename, 'rb+') as f:\n for header in dll.headers:\n f.seek(0)\n dll.write(f)\n f.seek(0, 2)\n f.flush()\n except Exception:\n pass\n\n\ndef mac_is_binary_signed(filename):\n \"\"\"\n Check if the given macOS binary file is signed.\n \"\"\"\n from macholib.MachO import MachO\n from macholib import mach_o # constants\n\n # Open the file\n try:\n m = MachO(filename)\n except Exception:\n return False\n\n # Walk over all headers and check if any contains LC_CODE_SIGNATURE\n # load command\n for header in m.headers:\n for cmd in header.commands:\n if cmd[0].cmd == mach_o.LC_CODE_SIGNATURE:\n return True\n return False\n\n\ndef mac_strip_signature(libname, distname):\n \"\"\"\n On macOS, strip away the signature from the binary file. As we may\n not be collecting all components from a signed framework bundle, the\n collection may invalidate the existing signature on a collected\n shared library, which will prevent the latter from being loaded.\n \"\"\"\n from ..compat import exec_command_rc\n\n # For now, limit this only to Python shared library. Other shared\n # library files from Python.framework bundle also seem to be signed,\n # but their signature is not invalidated by partial collection like\n # it is for Python library...\n if os.path.basename(libname) != 'Python':\n return\n if not mac_is_binary_signed(libname):\n return\n # Run codesign --remove-signature libname\n try:\n logger.debug(\"Removing signature from %s\", libname)\n result = exec_command_rc('codesign', '--remove-signature', libname)\n except Exception as e:\n logger.warning(\n \"Failed to run 'codesign' to remove signature from %s: %r\",\n libname, e)\n return\n if result != 0:\n logger.warning(\n \"'codesign --remove-signature %s' returned non-zero status %d\",\n libname, result)\n", "path": "PyInstaller/depend/dylib.py" } ]	diff --git a/PyInstaller/depend/dylib.py b/PyInstaller/depend/dylib.py index cf4ebe05d7..47eb327bf1 100644 --- a/PyInstaller/depend/dylib.py +++ b/PyInstaller/depend/dylib.py @@ -104,6 +104,7 @@ r'msvcp140_1\.dll', r'msvcp140_2\.dll', r'vcruntime140_1\.dll', + r'vcomp140\.dll', # Allow pythonNN.dll, pythoncomNN.dll, pywintypesNN.dll r'py(?:thon(?:com(?:loader)?)?\|wintypes)\d+\.dll',
zostera__django-bootstrap4-219	Use Markdown The README, HISTORY, CONTRIBUTING and AUTHORS file are written in RST. Markdown is easier to read and easier to write, and usually the standard for files like these. Let's use Markdown for these files. Also, rename HISTORY to CHANGELOG, this is a more recognizable name.	[ { "content": "import os\n\ntry:\n from importlib.metadata import metadata\nexcept ImportError:\n from importlib_metadata import metadata\n\nPROJECT_NAME = \"django-bootstrap4\"\n\non_rtd = os.environ.get(\"READTHEDOCS\", None) == \"True\"\nproject_metadata = metadata(PROJECT_NAME)\n\nproject = project_metadata[\"name\"]\nauthor = project_metadata[\"author\"]\ncopyright = f\"2020, {author}\"\n\n# The full version, including alpha/beta/rc tags, in x.y.z.misc format\nrelease = project_metadata[\"version\"]\n# The short X.Y version.\nversion = \".\".join(release.split(\".\")[:2])\n\nextensions = [\"sphinx.ext.autodoc\", \"sphinx.ext.viewcode\"]\npygments_style = \"sphinx\"\nhtmlhelp_basename = f\"{PROJECT_NAME}-doc\"\n\nif not on_rtd: # only import and set the theme if we're building docs locally\n import sphinx_rtd_theme\n\n html_theme = \"sphinx_rtd_theme\"\n html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n", "path": "docs/conf.py" } ]	[ { "content": "import os\n\ntry:\n from importlib.metadata import metadata\nexcept ImportError:\n from importlib_metadata import metadata\n\nPROJECT_NAME = \"django-bootstrap4\"\n\non_rtd = os.environ.get(\"READTHEDOCS\", None) == \"True\"\nproject_metadata = metadata(PROJECT_NAME)\n\nproject = project_metadata[\"name\"]\nauthor = project_metadata[\"author\"]\ncopyright = f\"2020, {author}\"\n\n# The full version, including alpha/beta/rc tags, in x.y.z.misc format\nrelease = project_metadata[\"version\"]\n# The short X.Y version.\nversion = \".\".join(release.split(\".\")[:2])\n\nextensions = [\"sphinx.ext.autodoc\", \"sphinx.ext.viewcode\", \"m2r\"]\nsource_suffix = [\".rst\", \".md\"]\npygments_style = \"sphinx\"\nhtmlhelp_basename = f\"{PROJECT_NAME}-doc\"\n\nif not on_rtd: # only import and set the theme if we're building docs locally\n import sphinx_rtd_theme\n\n html_theme = \"sphinx_rtd_theme\"\n html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]\n", "path": "docs/conf.py" } ]	diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..4128757e --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,25 @@ +# Authors + +This application is developed and maintained by [Zostera](https://zostera.nl). + +## Development Lead + +- Dylan Verheul <[email protected]> + +## Contributors + +- Allard Stijnman <[email protected]> +- Austin Whittier <[email protected]> +- Caio Ariede <[email protected]> +- Fabio C. Barrionuevo da Luz <[email protected]> +- Fabio Perfetti <[email protected]> +- Jay Pipes <[email protected]> +- Jonas Hagstedt <[email protected]> +- Jordan Starcher <[email protected]> +- Juan Carlos <[email protected]> +- Markus Holtermann <[email protected]> +- Nick S <[email protected]> +- Owais Lone <[email protected]> +- pmav99 <[email protected]> +- Richard Hajdu <[email protected]> +- Timothy Allen <[email protected]> diff --git a/AUTHORS.rst b/AUTHORS.rst deleted file mode 100644 index 8bd7c155..00000000 --- a/AUTHORS.rst +++ /dev/null @@ -1,29 +0,0 @@ -======= -Authors -======= - -This application is developed and maintained by `Zostera <https://zostera.nl>`_. - -Development Lead ----------------- - -* Dylan Verheul <[email protected]> - -Contributors ------------- - -* Allard Stijnman <[email protected]> -* Austin Whittier <[email protected]> -* Caio Ariede <[email protected]> -* Fabio C. Barrionuevo da Luz <[email protected]> -* Fabio Perfetti <[email protected]> -* Jay Pipes <[email protected]> -* Jonas Hagstedt <[email protected]> -* Jordan Starcher <[email protected]> -* Juan Carlos <[email protected]> -* Markus Holtermann <[email protected]> -* Nick S <[email protected]> -* Owais Lone <[email protected]> -* pmav99 <[email protected]> -* Richard Hajdu <[email protected]> -* Timothy Allen <[email protected]> diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..3268cd97 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,121 @@ +# Changelog + +## Unreleased + +- Convert HISTORY.rst to Markdown and rename to CHANGELOG.md. +- Convert README.rst, AUTHORS.rst and CONTRIBUTING.rst to Markdown, and change extension to .md. +- Update CONTRIBUTING.md to reflect use of `poetry`. + +## [2.0.1] - (2020-06-02) + +- Set beautifulsoup4 requirement to \>= 4.8.0 (fixes #216). +- Do not assume all inputs are inside labels (fixes #215). + +## [2.0.0] - (2020-06-01) + +- Use poetry (<https://python-poetry.org/>) for dependency management and packaging. +- Drop support for Python 3.5. +- Fix form-check-{label,input} classes applied too broadly. These should only be applied to labels and inputs found underneath the enclosing widget div for radio and checkbox select, not on the whole document. +- Allow to display radio and checkbox elements inline using the `form-check` classes. + +## [1.1.2] - (2019-12-13) + +- Restructure tox and Makefile. +- Add test for `bootstrap4.__version__`. + +## [1.1.1] - (2019-12-11) + +- Remove tag command from Makefile. +- Reinstate `bootstrap4.__version__` (#186). +- Add test for using a different jQuery version (#184). + +## [1.1.0] - (2019-12-09) + +- Update default Bootstrap to v4.3.1. +- Add support for Python 3.8, Django 3 and Django master. +- Switch to Django `manage.py` for test running. +- Update Makefile commands. +- Update tox configuration. +- Use correct license (BSD-3-Clause). +- Fix typo's in docstrings. +- Update Travis configuration. +- Drop MANIFEST.in, use `setuptools_scm`. +- Stop using `_version.py`, use git tags for versioning. +- Fixed issues with labels and input (#174 and #181). + +## [1.0.1] - (2019-08-30) + +- Fix support for Python 3.5 (#168). +- Set correct Python versions in setup.py. +- Fix `make test` command. + +## [1.0.0] - (2019-08-30) + +- Set default class for buttons to `btn-primary` (#150. +- Drop support for Python 2 and Django 1.11, 2.0 and 2.1 (#155). +- Template tag `bootstrap_field` now allows 3 values for `show_label`: `True`, `False`, `sr-only` and `skip\`. In the case of `False` / `sr-only` the label is hidden but present for screen readers. When `show_label` is set to `skip`, the label is not generated at all. +- Fix validation on input groups (#122). +- No longer duplicate jquery in bootstrap4.html (#139, #140). +- Apply `form-check`, `form-check-label` and `form-check-input` classes to appropriate tags for `RadioSelect` and `CheckboxSelectMultiple` widgets (#141). +- Errors on file inputs are shown (#146). +- Only display non-field errors in form alert block (#161). +- Reinstate `bootstrap4_title` block to `bootstrap4.html` (#156). +- Fix typo in `alert-dismissible` class (#142). +- Honor the `form_group_class` parameter in the `buttons` tag (#162). + +## [0.0.8] - (2019-03-12) + +- Drop support for the `base_url` setting (#105). +- Remove use of \"falsy\" as a string literal (#111). +- Fix javascript inclusion bugs (#71). +- Allow email to have addons (#131). +- Do not mark placeholder text as safe (#135). + +## [0.0.7] - (2018-08-22) + +- Improve alert accessibility (#93. +- Add a new widget: RadioSelectButtonGroup (#103. +- Several fixes and improvements to HTML renderin. +- Switch to explicit Travis test. +- Upgrade Bootstrap to 4.1.1 +- Upgrade jQuery to 3.3.1 +- Upgrade Popper to 1.14.3 +- Fixed `bootstrap4.html` to add jQuery per setting `include_jquery=[False\|'full'\|'slim']`. +- Adopt Black formatting, see <https://github.com/ambv/black>. + +## [0.0.6] - (2018-02-14) + +- Change form help text element from div to small (#60). +- Upgrade Bootstrap to 4.0.0 (#66). + +## [0.0.5] - (2018-01-03) + +- Drop develop branch, work with master and feature branche. +- Clean up `HISTORY.rst`. +- Upgrade Bootstrap to 4.0.0-beta.3. +- Use `col-4` rather than `col-xs-4` (#54). +- Added pagination alignment options (#56). +- Fixed form field errors and help texts (#39. +- Use django language if `USE_I18N=True` (#53). + +## [0.0.4] - (2017-10-26) + +- Upgrade Bootstrap to 4.0.0-beta.2. +- Fix settings, tags and tests for remote JS and CSS. + +## [0.0.3] - (2017-09-24) + +- Upgraded bootstrap4 to the beta version. + +## [0.0.2] - (2017-09-06, not released on PyPI) + +- Upgraded jQuery version from CDN to 3.2.1 (#17). +- Added proper pagination layout classes (#19). + +## [0.0.1] - (2017-06-04) + +- First releas. +- Remove `bootstrap_icon`, BS4 no longer has default icons. +- Various changes to get from 3 to 4, started MIGRATE.rst. +- Started `django-bootstrap4` based on `django-bootstrap3`. +- Thanks everybody that contributed to `django-bootstrap3`! \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c3876e95 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,82 @@ +# Contributing + +Contributions are welcome, and they are greatly appreciated! Every +little bit helps, and credit will always be given. + +You can contribute in many ways: + +## Types of Contributions + +### Report Bugs + +Report bugs at <https://github.com/zostera/django-bootstrap4/issues>. + +If you are reporting a bug, please include: + +- Your operating system name and version. +- Any details about your local setup that might be helpful in troubleshooting. +- Detailed steps to reproduce the bug. + +### Fix Bugs + +Look through the GitHub issues for bugs. Anything tagged with \"bug\" is open to whoever wants to implement it. + +### Implement Features + +Look through the GitHub issues for features. Anything tagged with \"feature\" is open to whoever wants to implement it. + +### Write Documentation + +`django-bootstrap4` could always use more documentation, whether as part of the official django-bootstrap4 docs, in docstrings, or even on the web in blog posts, articles, and such. + +### Submit Feedback + +The best way to send feedback is to file an issue at +<https://github.com/zostera/django-bootstrap4/issues>. + +If you are proposing a feature: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible, to make it easier to implement. + +## Get Started! + +Ready to contribute? Here\'s how to set up `django-bootstrap4` for local development. + +You will need some knowledge of git, github, and Python/Django development. Using a Python virtual environment is advised. + +1. Fork and clone `django-bootstrap4` repo on GitHub. There is an excellent guide at <https://guides.github.com/activities/forking/>. +2. Install [poetry](https://python-poetry.org). +3. Inside your local `django-bootstrap4` folder, run + ```shell script + $ poetry install + ``` +4. Create a branch for local development: + ```shell script + $ git checkout -b name-of-your-bugfix-or-feature + ``` + Now you can make your changes locally. +5. When you\'re done making changes, check that your changes pass the tests. + Run the unit tests in your virtual environment with the `manage.py` command: + ```shell script + $ python manage.py test + ```` + Run the extended tests with `tox`: + ```shell script + $ make tox + ``` +6. Commit your changes and push your branch to GitHub: + ```shell script + $ git add . + $ git commit -m "Your detailed description of your changes." + $ git push origin name-of-your-bugfix-or-feature + ``` +7. Submit a pull request through the GitHub website. + +## Pull Request Guidelines + +Before you submit a pull request, check that it meets these guidelines: + +1. The pull request should include tests. +2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in CHANGELOG.md. +3. The pull request should pass the Continuous Integration tests. Check <https://travis-ci.org/zostera/django-bootstrap4/pull_requests> and make sure that all tests pass. You can run the tests locally using `tox`. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst deleted file mode 100644 index a877140d..00000000 --- a/CONTRIBUTING.rst +++ /dev/null @@ -1,115 +0,0 @@ -============ -Contributing -============ - -Contributions are welcome, and they are greatly appreciated! Every -little bit helps, and credit will always be given. - -You can contribute in many ways: - -Types of Contributions ----------------------- - -Report Bugs -~~~~~~~~~~~ - -Report bugs at https://github.com/zostera/django-bootstrap4/issues. - -If you are reporting a bug, please include: - -* Your operating system name and version. -* Any details about your local setup that might be helpful in troubleshooting. -* Detailed steps to reproduce the bug. - -Fix Bugs -~~~~~~~~ - -Look through the GitHub issues for bugs. Anything tagged with "bug" -is open to whoever wants to implement it. - -Implement Features -~~~~~~~~~~~~~~~~~~ - -Look through the GitHub issues for features. Anything tagged with "feature" -is open to whoever wants to implement it. - -Write Documentation -~~~~~~~~~~~~~~~~~~~ - -django-bootstrap4 could always use more documentation, whether as part of the -official django-bootstrap4 docs, in docstrings, or even on the web in blog posts, -articles, and such. - -Submit Feedback -~~~~~~~~~~~~~~~ - -The best way to send feedback is to file an issue at https://github.com/zostera/django-bootstrap4/issues. - -If you are proposing a feature: - -* Explain in detail how it would work. -* Keep the scope as narrow as possible, to make it easier to implement. -* Remember that this is a volunteer-driven project, and that contributions - are welcome :) - -Get Started! ------------- - -Ready to contribute? Here's how to set up `django-bootstrap4` for local development. - -1. Fork the `django-bootstrap4` repo on GitHub. -2. Clone your fork locally:: - - $ git clone https://github.com/your_username_here/django-bootstrap4.git - -3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:: - - $ mkvirtualenv django-bootstrap4 - $ cd django-bootstrap4/ - $ pip install -r requirements.txt - $ python setup.py develop - -4. Create a branch for local development:: - - $ git checkout -b name-of-your-bugfix-or-feature - -Now you can make your changes locally. - -5. When you're done making changes, check that your changes pass flake8 and the -tests, including testing other Python versions with tox:: - - $ flake8 bootstrap4 tests - $ python setup.py test - $ tox - -To get flake8 and tox, just pip install them into your virtualenv. - -6. Commit your changes and push your branch to GitHub:: - - $ git add . - $ git commit -m "Your detailed description of your changes." - $ git push origin name-of-your-bugfix-or-feature - -7. Submit a pull request through the GitHub website. - -Pull Request Guidelines ------------------------ - -Before you submit a pull request, check that it meets these guidelines: - -1. The pull request should include tests. -2. If the pull request adds functionality, the docs should be updated. Put - your new functionality into a function with a docstring, and add the - feature to the list in README.rst. -3. The pull request should pass the Continuous Integration tests. Check - https://travis-ci.org/dyve/django-bootstrap4/pull_requests - and make sure that all tests pass. You can run the tests locally - using `tox`. - -Tips ----- - -To run a subset of tests:: - - $ python manage.py test tests.test_components - diff --git a/HISTORY.rst b/HISTORY.rst deleted file mode 100644 index 74f5af3d..00000000 --- a/HISTORY.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. :changelog: - -History -------- - -2.0.1 (2020-06-02) -++++++++++++++++++ -- Set beautifulsoup4 requirement to >= 4.8.0 (fixes #216). -- Do not assume all inputs are inside labels (fixes #215). - -2.0.0 (2020-06-01) -++++++++++++++++++ -- Use poetry (https://python-poetry.org/) for dependency management and packaging. -- Drop support for Python 3.5. -- Fix form-check-{label,input} classes applied too broadly. These should only be applied to labels and inputs found underneath the enclosing widget div for radio and checkbox select, not on the whole document. -- Allow to display radio and checkbox elements inline using the form-check classes. - -1.1.2 (2019-12-13) -++++++++++++++++++ -- Restructure tox and Makefile -- Add test for `bootstrap4.__version__` - -1.1.1 (2019-12-11) -++++++++++++++++++ -- Remove tag command from Makefile -- Reinstate `bootstrap4.__version__` (#186) -- Add test for using a different jQuery version (#184) - -1.1.0 (2019-12-09) -++++++++++++++++++ -- Update default Bootstrap to v4.3.1 -- Add support for Python 3.8, Django 3 and Django master -- Switch to Django `manage.py` for test running -- Update Makefile commands -- Update tox configuration -- Use correct license (BSD-3-Clause) -- Fix typo's in docstrings -- Update Travis configuration -- Drop MANIFEST.in, use setuptools_scm -- Stop using _version.py, use git tags for versioning -- Fixed issues with labels and input (#174 and #181) - -1.0.1 (2019-08-30) -++++++++++++++++++ -- Fix support for Python 3.5 (#168) -- Set correct Python versions in setup.py -- Fix `make test` command - -1.0.0 (2019-08-30) -++++++++++++++++++ -- Set default class for buttons to `btn-primary` (#150) -- Drop support for Python 2 and Django 1.11, 2.0 and 2.1 (#155) -- Template tag `bootstrap_field` now allows 3 values for `show_label`: `True`, `False` / `'sr-only'` and `'skip'`. In the case of `False` / `'sr-only'` the label is hidden but present for screen readers. When `show_label` is set to `'skip'`, the label is not generated at all. -- Fix validation on input groups (#122) -- No longer duplicate jquery in bootstrap4.html (#139, #140) -- Apply `form-check`, `form-check-label` and `form-check-input` classes to appropriate tags for `RadioSelect` and `CheckboxSelectMultiple` widgets (#141) -- Errors on file inputs are shown (#146) -- Only display non-field errors in form alert block (#161) -- Reinstate `bootstrap4_title` block to `bootstrap4.html` (#156) -- Fix typo in `alert-dismissible` class (#142) -- Honor the `form_group_class` parameter in the `buttons` tag (#162) - -0.0.8 (2019-03-12) -++++++++++++++++++ -- Drop support for the `base_url` setting (#105) -- Remove use of "falsy" as a string literal (#111) -- Fix javascript inclusion bugs (#71) -- Allow email to have addons (#131) -- Do not mark placeholder text as safe (#135) -- Adopt black - -0.0.7 (2018-08-22) -++++++++++++++++++ -- Improve alert accessibility (#93) -- Add a new widget: RadioSelectButtonGroup (#103) -- Several fixes and improvements to HTML rendering -- Switch to explicit Travis tests -- Upgrade Bootstrap to 4.1.1 -- Upgrade jQuery to 3.3.1 -- Upgrade Popper to 1.14.3 -- Fixed bootstrap4.html to add jQuery per setting 'include_jquery' [False\|True\|'full'\|'slim'] -- Adopt Black formatting, see https://github.com/ambv/black - -0.0.6 (2018-02-14) -+++++++++++++++++++ -- Change form help text element from div to small (#60) -- Upgrade Bootstrap to 4.0.0 (#66) - -0.0.5 (2018-01-03) -++++++++++++++++++ -- Drop develop branch, work with master and feature branches -- Clean up history file -- Upgrade Bootstrap to 4.0.0-beta.3 -- Use `col-4` rather than `col-xs-4` (#54) -- Added pagination alignment options (#56) -- Fixed form field errors and help texts (#39) -- Use django language if ``USE_I18N=True`` (#53) - -0.0.4 (2017-10-26) -++++++++++++++++++ -- Upgrade Bootstrap to 4.0.0-beta.2 -- Fix settings, tags and tests for remote JS and CSS - -0.0.3 (2017-09-24) -++++++++++++++++++ -- Upgraded bootstrap4 to the beta version - -0.0.2 (2017-09-06, not released on PyPI) -++++++++++++++++++++++++++++++++++++++++ -- Upgraded jQuery version from CDN to 3.2.1 (#17) -- Added proper pagination layout classes (#19) - -0.0.1 (2017-06-04) -++++++++++++++++++ -- First release - -Unreleased (2017-04-25) -+++++++++++++++++++++++ -- Remove `bootstrap_icon`, BS4 no longer has default icons. -- Various changes to get from 3 to 4, started MIGRATE.rst. -- Started `django-bootstrap4` based on `django-bootstrap3`. -- Thanks everybody that contributed to `django-bootstrap3`! diff --git a/MIGRATE.rst b/MIGRATE.rst deleted file mode 100644 index 205676f4..00000000 --- a/MIGRATE.rst +++ /dev/null @@ -1,16 +0,0 @@ -========= -Migration -========= - -Below is a list of caveats when migrating from Bootstrap3/django-bootstrap3 to Bootstrap4/django-bootstrap4. - -This document only considers the differences between django-bootstrap3 and django-bootstrap4. For the migration -guide from Bootstrap 3 to 4, please look at the Bootstrap docs, especially the `Migration section <https://getbootstrap.com/docs/4.0/migration/>`_. - -Icons ------ - -Bootstrap 4 does not ship with an icon set, so everything regarding to icons has been removed. - -If you need easy access to icons that are compatible with Bootstrap 4, please consider -https://github.com/zostera/django-icons. diff --git a/README.rst b/README.md similarity index 100% rename from README.rst rename to README.md diff --git a/docs/authors.rst b/docs/authors.rst index 94292d01..e8812ff2 100644 --- a/docs/authors.rst +++ b/docs/authors.rst @@ -1 +1 @@ -.. include:: ../AUTHORS.rst \ No newline at end of file +.. mdinclude:: ../AUTHORS.md \ No newline at end of file diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 00000000..5ec4a0ec --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1 @@ +.. mdinclude:: ../CHANGELOG.md \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 078c8029..4fa8af95 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,8 @@ # The short X.Y version. version = ".".join(release.split(".")[:2]) -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] +extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "m2r"] +source_suffix = [".rst", ".md"] pygments_style = "sphinx" htmlhelp_basename = f"{PROJECT_NAME}-doc" diff --git a/docs/contributing.rst b/docs/contributing.rst deleted file mode 100644 index 3bdd7dc2..00000000 --- a/docs/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../CONTRIBUTING.rst \ No newline at end of file diff --git a/docs/history.rst b/docs/history.rst deleted file mode 100644 index bec23d82..00000000 --- a/docs/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../HISTORY.rst \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 7400a9e9..3c936bf8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -13,6 +13,5 @@ Contents: settings templates widgets - contributing authors - history + changelog diff --git a/docs/migrate.rst b/docs/migrate.rst index 3ba00db1..ba57ea76 100644 --- a/docs/migrate.rst +++ b/docs/migrate.rst @@ -1 +1,16 @@ -.. include:: ../MIGRATE.rst \ No newline at end of file +========= +Migration +========= + +Below is a list of caveats when migrating from Bootstrap3/django-bootstrap3 to Bootstrap4/django-bootstrap4. + +This document only considers the differences between django-bootstrap3 and django-bootstrap4. For the migration +guide from Bootstrap 3 to 4, please look at the Bootstrap docs, especially the `Migration section <https://getbootstrap.com/docs/4.5/migration/>`_. + +Icons +----- + +Bootstrap 4 does not ship with an icon set, so everything regarding to icons has been removed. + +If you need easy access to icons that are compatible with Bootstrap 4, please consider +https://github.com/zostera/django-icons. diff --git a/poetry.lock b/poetry.lock index b2c53c91..cdf27807 100644 --- a/poetry.lock +++ b/poetry.lock @@ -177,7 +177,7 @@ untokenize = "" category = "main" description = "Docutils -- Python Documentation Utilities" name = "docutils" -optional = true +optional = false python-versions = ">=2.7, !=3.0., !=3.1., !=3.2., !=3.3., !=3.4." version = "0.16" @@ -262,7 +262,7 @@ i18n = ["Babel (>=0.8)"] category = "main" description = "Markdown and reStructuredText in a single file." name = "m2r" -optional = true +optional = false python-versions = "" version = "0.2.1" @@ -290,7 +290,7 @@ version = "0.6.1" category = "main" description = "The fastest markdown parser in pure Python" name = "mistune" -optional = true +optional = false python-versions = "" version = "0.8.4" @@ -590,7 +590,7 @@ testing = ["jaraco.itertools", "func-timeout"] docs = ["sphinx", "m2r"] [metadata] -content-hash = "7236b74229de4bfc002db0e422dae48f78646b98dcd4dec46c5885fbe53d21c8" +content-hash = "82aaba408ae0ee1852e3c6a67dc0d448a0a518b3954caa65c4e23c159e62a81f" python-versions = "^3.6" [metadata.files] diff --git a/pyproject.toml b/pyproject.toml index e02bc466..50e0cb02 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,13 +1,13 @@ [tool.poetry] name = "django-bootstrap4" -version = "2.0.1" +version = "2.0.2" description = "Bootstrap support for Django projects" homepage = "https://github.com/zostera/django-bootstrap4" repository = "https://github.com/zostera/django-bootstrap4" documentation = "https://django-bootstrap4.readthedocs.io/" authors = ["Dylan Verheul <[email protected]>"] license = "BSD-3-Clause" -readme = "README.rst" +readme = "README.md" keywords= ["django", "django-bootstrap4", "bootstrap4", "bootstrap"] classifiers = [ "Development Status :: 5 - Production/Stable", @@ -49,6 +49,7 @@ flake8 = "^3.7.9" docformatter = "^1.3.1" pydocstyle = "^5.0.2" coverage = {extras = ["toml"], version = "^5.0.4"} +m2r = "^0.2.1" [tool.poetry.extras] docs = ["sphinx", "sphinx_rts_theme", "m2r"]
evennia__evennia-2708	[BUG - Develop] Global scripts are not being started, only restarted. #### Describe the bug When creating a new game, global scripts are not automatically started. #### To Reproduce Steps to reproduce the behavior: 1. Create a new game dir. 2. Create a script with `at_repeat` and add it to your server conf. 3. `evennia migrate` and `evennia start` 4. Check global scripts status. 5. See error #### Expected behavior Global scripts are supposed to start automatically. #### Develop-branch commit f093c8bcb #### Additional context I used the following dict in my settings: ```python GLOBAL_SCRIPTS = { "test_script": { "typeclass": "typeclasses.scripts.TestScript", "persistent": True, "interval": 20, "desc": "Testing script starting and iteration." }, } ``` And the following script class: ```python class TestScript(Script): def at_repeat(self): print("hey, listen") ``` The script loaded correctly, and I was able to manually start it. After fully stopping and then starting the server, the script was automatically started again. However, if I create a new game, start the server, and I _don't_ manually start the script, then fully stopping and then starting the server again does _not_ automatically start the script.	[ { "content": "\"\"\"\nContainers\n\nContainers are storage classes usually initialized from a setting. They\nrepresent Singletons and acts as a convenient place to find resources (\navailable as properties on the singleton)\n\nevennia.GLOBAL_SCRIPTS\nevennia.OPTION_CLASSES\n\n\"\"\"\n\n\nfrom pickle import dumps\nfrom django.conf import settings\nfrom evennia.utils.utils import class_from_module, callables_from_module\nfrom evennia.utils import logger\n\n\nSCRIPTDB = None\n\n\nclass Container:\n \"\"\"\n Base container class. A container is simply a storage object whose\n properties can be acquired as a property on it. This is generally\n considered a read-only affair.\n\n The container is initialized by a list of modules containing callables.\n\n \"\"\"\n\n storage_modules = []\n\n def __init__(self):\n \"\"\"\n Read data from module.\n\n \"\"\"\n self.loaded_data = None\n\n def load_data(self):\n \"\"\"\n Delayed import to avoid eventual circular imports from inside\n the storage modules.\n\n \"\"\"\n if self.loaded_data is None:\n self.loaded_data = {}\n for module in self.storage_modules:\n self.loaded_data.update(callables_from_module(module))\n\n def __getattr__(self, key):\n return self.get(key)\n\n def get(self, key, default=None):\n \"\"\"\n Retrive data by key (in case of not knowing it beforehand).\n\n Args:\n key (str): The name of the script.\n default (any, optional): Value to return if key is not found.\n\n Returns:\n any (any): The data loaded on this container.\n\n \"\"\"\n self.load_data()\n return self.loaded_data.get(key, default)\n\n def all(self):\n \"\"\"\n Get all stored data\n\n Returns:\n scripts (list): All global script objects stored on the container.\n\n \"\"\"\n self.load_data()\n return list(self.loaded_data.values())\n\n\nclass OptionContainer(Container):\n \"\"\"\n Loads and stores the final list of OPTION CLASSES.\n\n Can access these as properties or dictionary-contents.\n \"\"\"\n\n storage_modules = settings.OPTION_CLASS_MODULES\n\n\nclass GlobalScriptContainer(Container):\n \"\"\"\n Simple Handler object loaded by the Evennia API to contain and manage a\n game's Global Scripts. This will list global Scripts created on their own\n but will also auto-(re)create scripts defined in `settings.GLOBAL_SCRIPTS`.\n\n Example:\n import evennia\n evennia.GLOBAL_SCRIPTS.scriptname\n\n Note:\n This does not use much of the BaseContainer since it's not loading\n callables from settings but a custom dict of tuples.\n\n \"\"\"\n\n def __init__(self):\n \"\"\"\n Note: We must delay loading of typeclasses since this module may get\n initialized before Scripts are actually initialized.\n\n \"\"\"\n self.typeclass_storage = None\n self.loaded_data = {\n key: {} if data is None else data for key, data in settings.GLOBAL_SCRIPTS.items()\n }\n\n def _get_scripts(self, key=None, default=None):\n global SCRIPTDB\n if not SCRIPTDB:\n from evennia.scripts.models import ScriptDB as SCRIPTDB\n if key:\n try:\n return SCRIPTDB.objects.get(db_key__exact=key, db_obj__isnull=True)\n except SCRIPTDB.DoesNotExist:\n return default\n else:\n return SCRIPTDB.objects.filter(db_obj__isnull=True)\n\n def _load_script(self, key):\n self.load_data()\n\n typeclass = self.typeclass_storage[key]\n script = typeclass.objects.filter(\n db_key=key, db_account__isnull=True, db_obj__isnull=True\n ).first()\n\n kwargs = {self.loaded_data[key]}\n kwargs[\"key\"] = key\n kwargs[\"persistent\"] = kwargs.get(\"persistent\", True)\n\n compare_hash = str(dumps(kwargs, protocol=4))\n\n if script:\n script_hash = script.attributes.get(\"global_script_settings\", category=\"settings_hash\")\n if script_hash is None:\n # legacy - store the hash anew and assume no change\n script.attributes.add(\n \"global_script_settings\", compare_hash, category=\"settings_hash\"\n )\n elif script_hash != compare_hash:\n # wipe the old version and create anew\n logger.log_info(f\"GLOBAL_SCRIPTS: Settings changed for {key} ({typeclass}).\")\n script.stop()\n script.delete()\n script = None\n\n if not script:\n logger.log_info(f\"GLOBAL_SCRIPTS: (Re)creating {key} ({typeclass}).\")\n\n script, errors = typeclass.create(kwargs)\n if errors:\n logger.log_err(\"\\n\".join(errors))\n return None\n\n # store a hash representation of the setup\n script.attributes.add(\"_global_script_settings\", compare_hash, category=\"settings_hash\")\n script.start()\n\n return script\n\n def start(self):\n \"\"\"\n Called last in evennia.__init__ to initialize the container late\n (after script typeclasses have finished loading).\n\n We include all global scripts in the handler and\n make sure to auto-load time-based scripts.\n\n \"\"\"\n # populate self.typeclass_storage\n self.load_data()\n\n # start registered scripts\n for key in self.loaded_data:\n self._load_script(key)\n\n def load_data(self):\n \"\"\"\n This delayed import avoids trying to load Scripts before they are\n initialized.\n\n \"\"\"\n if self.typeclass_storage is None:\n self.typeclass_storage = {}\n for key, data in self.loaded_data.items():\n try:\n typeclass = data.get(\"typeclass\", settings.BASE_SCRIPT_TYPECLASS)\n self.typeclass_storage[key] = class_from_module(typeclass)\n except Exception:\n logger.log_trace(\n f\"GlobalScriptContainer could not start import global script {key}.\"\n )\n\n def get(self, key, default=None):\n \"\"\"\n Retrive data by key (in case of not knowing it beforehand). Any\n scripts that are in settings.GLOBAL_SCRIPTS that are not found\n will be recreated on-demand.\n\n Args:\n key (str): The name of the script.\n default (any, optional): Value to return if key is not found\n at all on this container (i.e it cannot be loaded at all).\n\n Returns:\n any (any): The data loaded on this container.\n \"\"\"\n res = self._get_scripts(key)\n if not res:\n if key in self.loaded_data:\n # recreate if we have the info\n return self._load_script(key) or default\n return default\n return res\n\n def all(self):\n \"\"\"\n Get all global scripts. Note that this will not auto-start\n scripts defined in settings.\n\n Returns:\n scripts (list): All global script objects stored on the container.\n\n \"\"\"\n self.typeclass_storage = None\n self.load_data()\n for key in self.loaded_data:\n self._load_script(key)\n return self._get_scripts(None)\n\n\n# Create all singletons\n\nGLOBAL_SCRIPTS = GlobalScriptContainer()\nOPTION_CLASSES = OptionContainer()\n", "path": "evennia/utils/containers.py" } ]	[ { "content": "\"\"\"\nContainers\n\nContainers are storage classes usually initialized from a setting. They\nrepresent Singletons and acts as a convenient place to find resources (\navailable as properties on the singleton)\n\nevennia.GLOBAL_SCRIPTS\nevennia.OPTION_CLASSES\n\n\"\"\"\n\n\nfrom pickle import dumps\nfrom django.conf import settings\nfrom evennia.utils.utils import class_from_module, callables_from_module\nfrom evennia.utils import logger\n\n\nSCRIPTDB = None\n\n\nclass Container:\n \"\"\"\n Base container class. A container is simply a storage object whose\n properties can be acquired as a property on it. This is generally\n considered a read-only affair.\n\n The container is initialized by a list of modules containing callables.\n\n \"\"\"\n\n storage_modules = []\n\n def __init__(self):\n \"\"\"\n Read data from module.\n\n \"\"\"\n self.loaded_data = None\n\n def load_data(self):\n \"\"\"\n Delayed import to avoid eventual circular imports from inside\n the storage modules.\n\n \"\"\"\n if self.loaded_data is None:\n self.loaded_data = {}\n for module in self.storage_modules:\n self.loaded_data.update(callables_from_module(module))\n\n def __getattr__(self, key):\n return self.get(key)\n\n def get(self, key, default=None):\n \"\"\"\n Retrive data by key (in case of not knowing it beforehand).\n\n Args:\n key (str): The name of the script.\n default (any, optional): Value to return if key is not found.\n\n Returns:\n any (any): The data loaded on this container.\n\n \"\"\"\n self.load_data()\n return self.loaded_data.get(key, default)\n\n def all(self):\n \"\"\"\n Get all stored data\n\n Returns:\n scripts (list): All global script objects stored on the container.\n\n \"\"\"\n self.load_data()\n return list(self.loaded_data.values())\n\n\nclass OptionContainer(Container):\n \"\"\"\n Loads and stores the final list of OPTION CLASSES.\n\n Can access these as properties or dictionary-contents.\n \"\"\"\n\n storage_modules = settings.OPTION_CLASS_MODULES\n\n\nclass GlobalScriptContainer(Container):\n \"\"\"\n Simple Handler object loaded by the Evennia API to contain and manage a\n game's Global Scripts. This will list global Scripts created on their own\n but will also auto-(re)create scripts defined in `settings.GLOBAL_SCRIPTS`.\n\n Example:\n import evennia\n evennia.GLOBAL_SCRIPTS.scriptname\n\n Note:\n This does not use much of the BaseContainer since it's not loading\n callables from settings but a custom dict of tuples.\n\n \"\"\"\n\n def __init__(self):\n \"\"\"\n Note: We must delay loading of typeclasses since this module may get\n initialized before Scripts are actually initialized.\n\n \"\"\"\n self.typeclass_storage = None\n self.loaded_data = {\n key: {} if data is None else data for key, data in settings.GLOBAL_SCRIPTS.items()\n }\n\n def _get_scripts(self, key=None, default=None):\n global SCRIPTDB\n if not SCRIPTDB:\n from evennia.scripts.models import ScriptDB as SCRIPTDB\n if key:\n try:\n return SCRIPTDB.objects.get(db_key__exact=key, db_obj__isnull=True)\n except SCRIPTDB.DoesNotExist:\n return default\n else:\n return SCRIPTDB.objects.filter(db_obj__isnull=True)\n\n def _load_script(self, key):\n self.load_data()\n\n typeclass = self.typeclass_storage[key]\n script = typeclass.objects.filter(\n db_key=key, db_account__isnull=True, db_obj__isnull=True\n ).first()\n\n kwargs = {self.loaded_data[key]}\n kwargs[\"key\"] = key\n kwargs[\"persistent\"] = kwargs.get(\"persistent\", True)\n\n compare_hash = str(dumps(kwargs, protocol=4))\n\n if script:\n script_hash = script.attributes.get(\"global_script_settings\", category=\"settings_hash\")\n if script_hash is None:\n # legacy - store the hash anew and assume no change\n script.attributes.add(\n \"global_script_settings\", compare_hash, category=\"settings_hash\"\n )\n elif script_hash != compare_hash:\n # wipe the old version and create anew\n logger.log_info(f\"GLOBAL_SCRIPTS: Settings changed for {key} ({typeclass}).\")\n script.stop()\n script.delete()\n script = None\n\n if not script:\n logger.log_info(f\"GLOBAL_SCRIPTS: (Re)creating {key} ({typeclass}).\")\n\n script, errors = typeclass.create(kwargs)\n if errors:\n logger.log_err(\"\\n\".join(errors))\n return None\n\n # store a hash representation of the setup\n script.attributes.add(\"_global_script_settings\", compare_hash, category=\"settings_hash\")\n script.start()\n\n return script\n\n def start(self):\n \"\"\"\n Called last in evennia.__init__ to initialize the container late\n (after script typeclasses have finished loading).\n\n We include all global scripts in the handler and\n make sure to auto-load time-based scripts.\n\n \"\"\"\n # populate self.typeclass_storage\n self.load_data()\n\n # start registered scripts\n for key in self.loaded_data:\n self._load_script(key)\n\n def load_data(self):\n \"\"\"\n This delayed import avoids trying to load Scripts before they are\n initialized.\n\n \"\"\"\n if self.typeclass_storage is None:\n self.typeclass_storage = {}\n for key, data in self.loaded_data.items():\n try:\n typeclass = data.get(\"typeclass\", settings.BASE_SCRIPT_TYPECLASS)\n self.typeclass_storage[key] = class_from_module(typeclass)\n except Exception:\n logger.log_trace(\n f\"GlobalScriptContainer could not start import global script {key}.\"\n )\n\n def get(self, key, default=None):\n \"\"\"\n Retrive data by key (in case of not knowing it beforehand). Any\n scripts that are in settings.GLOBAL_SCRIPTS that are not found\n will be recreated on-demand.\n\n Args:\n key (str): The name of the script.\n default (any, optional): Value to return if key is not found\n at all on this container (i.e it cannot be loaded at all).\n\n Returns:\n any (any): The data loaded on this container.\n \"\"\"\n res = self._get_scripts(key)\n if not res:\n if key in self.loaded_data:\n # recreate if we have the info\n return self._load_script(key) or default\n return default\n return res\n\n def all(self):\n \"\"\"\n Get all global scripts. Note that this will not auto-start\n scripts defined in settings.\n\n Returns:\n scripts (list): All global script objects stored on the container.\n\n \"\"\"\n self.typeclass_storage = None\n self.load_data()\n for key in self.loaded_data:\n self._load_script(key)\n return self._get_scripts(None)\n\n\n# Create all singletons\n\nGLOBAL_SCRIPTS = GlobalScriptContainer()\nOPTION_CLASSES = OptionContainer()\n", "path": "evennia/utils/containers.py" } ]	diff --git a/evennia/utils/containers.py b/evennia/utils/containers.py index 6b709fbf75d..85678ee03ee 100644 --- a/evennia/utils/containers.py +++ b/evennia/utils/containers.py @@ -167,7 +167,7 @@ def _load_script(self, key): # store a hash representation of the setup script.attributes.add("_global_script_settings", compare_hash, category="settings_hash") - script.start() + script.start() return script
svthalia__concrexit-1767	Delete tpay payment if order is modified ### Summary Right now it is possible to order a pizza, pay it with tpay, change the order to a pizza with a different price, and the payment will not match the order anymore. ### How to test 1. Order a pizza 2. Pay with tpay 3. Change the order 4. The payment should be deleted 5. If the event is over, or the payment is batched, then changing the order should crash	[ { "content": "\"\"\"Views provided by the pizzas package.\"\"\"\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import Http404\nfrom django.shortcuts import get_object_or_404, render, redirect\nfrom django.utils.translation import gettext_lazy as _\nfrom django.views.decorators.http import require_http_methods\n\nfrom payments.services import delete_payment\nfrom .models import FoodOrder, FoodEvent, Product\n\n\n@login_required\ndef index(request):\n \"\"\"Overview of user order for a pizza event.\"\"\"\n products = Product.available_products.order_by(\"name\")\n if not request.user.has_perm(\"pizzas.order_restricted_products\"):\n products = products.exclude(restricted=True)\n event = FoodEvent.current()\n try:\n obj = FoodOrder.objects.get(food_event=event, member=request.member)\n except FoodOrder.DoesNotExist:\n obj = None\n context = {\"event\": event, \"products\": products, \"order\": obj}\n return render(request, \"pizzas/index.html\", context)\n\n\n@require_http_methods([\"POST\"])\ndef cancel_order(request):\n \"\"\"View that cancels a user's order.\"\"\"\n if \"order\" in request.POST:\n try:\n order = get_object_or_404(FoodOrder, pk=int(request.POST[\"order\"]))\n if not order.can_be_changed:\n messages.error(request, _(\"You can no longer cancel.\"))\n elif order.member == request.member:\n order.delete()\n messages.success(request, _(\"Your order has been cancelled.\"))\n except Http404:\n messages.error(request, _(\"Your order could not be found.\"))\n return redirect(\"pizzas:index\")\n\n\n@login_required\ndef place_order(request):\n \"\"\"View that shows the detail of the current order.\"\"\"\n event = FoodEvent.current()\n if not event:\n return redirect(\"pizzas:index\")\n\n try:\n obj = FoodOrder.objects.get(food_event=event, member=request.member)\n current_order_locked = not obj.can_be_changed\n except FoodOrder.DoesNotExist:\n obj = None\n current_order_locked = False\n\n if \"product\" in request.POST and not current_order_locked:\n productset = Product.available_products.all()\n if not request.user.has_perm(\"pizzas.order_restricted_products\"):\n productset = productset.exclude(restricted=True)\n try:\n product = productset.get(pk=int(request.POST[\"product\"]))\n except Product.DoesNotExist as e:\n raise Http404(\"Pizza does not exist\") from e\n if not obj:\n obj = FoodOrder(food_event=event, member=request.member)\n obj.product = product\n if obj.payment:\n delete_payment(obj.payment)\n obj.save()\n return redirect(\"pizzas:index\")\n", "path": "website/pizzas/views.py" } ]	[ { "content": "\"\"\"Views provided by the pizzas package.\"\"\"\nfrom django.contrib import messages\nfrom django.contrib.auth.decorators import login_required\nfrom django.http import Http404\nfrom django.shortcuts import get_object_or_404, render, redirect\nfrom django.utils.translation import gettext_lazy as _\nfrom django.views.decorators.http import require_http_methods\n\nfrom payments.services import delete_payment\nfrom .models import FoodOrder, FoodEvent, Product\n\n\n@login_required\ndef index(request):\n \"\"\"Overview of user order for a pizza event.\"\"\"\n products = Product.available_products.order_by(\"name\")\n if not request.user.has_perm(\"pizzas.order_restricted_products\"):\n products = products.exclude(restricted=True)\n event = FoodEvent.current()\n try:\n obj = FoodOrder.objects.get(food_event=event, member=request.member)\n except FoodOrder.DoesNotExist:\n obj = None\n context = {\"event\": event, \"products\": products, \"order\": obj}\n return render(request, \"pizzas/index.html\", context)\n\n\n@require_http_methods([\"POST\"])\ndef cancel_order(request):\n \"\"\"View that cancels a user's order.\"\"\"\n if \"order\" in request.POST:\n try:\n order = get_object_or_404(FoodOrder, pk=int(request.POST[\"order\"]))\n if not order.can_be_changed:\n messages.error(request, _(\"You can no longer cancel.\"))\n elif order.member == request.member:\n order.delete()\n messages.success(request, _(\"Your order has been cancelled.\"))\n except Http404:\n messages.error(request, _(\"Your order could not be found.\"))\n return redirect(\"pizzas:index\")\n\n\n@login_required\ndef place_order(request):\n \"\"\"View that shows the detail of the current order.\"\"\"\n event = FoodEvent.current()\n if not event:\n return redirect(\"pizzas:index\")\n\n try:\n obj = FoodOrder.objects.get(food_event=event, member=request.member)\n current_order_locked = not obj.can_be_changed\n except FoodOrder.DoesNotExist:\n obj = None\n current_order_locked = False\n\n if \"product\" in request.POST and not current_order_locked:\n productset = Product.available_products.all()\n if not request.user.has_perm(\"pizzas.order_restricted_products\"):\n productset = productset.exclude(restricted=True)\n try:\n product = productset.get(pk=int(request.POST[\"product\"]))\n except Product.DoesNotExist as e:\n raise Http404(\"Pizza does not exist\") from e\n if not obj:\n obj = FoodOrder(food_event=event, member=request.member)\n obj.product = product\n if obj.payment:\n delete_payment(obj)\n obj.save()\n return redirect(\"pizzas:index\")\n", "path": "website/pizzas/views.py" } ]	diff --git a/website/pizzas/views.py b/website/pizzas/views.py index ffcf4c60c..f23167551 100644 --- a/website/pizzas/views.py +++ b/website/pizzas/views.py @@ -67,6 +67,6 @@ def place_order(request): obj = FoodOrder(food_event=event, member=request.member) obj.product = product if obj.payment: - delete_payment(obj.payment) + delete_payment(obj) obj.save() return redirect("pizzas:index")
boto__boto-2475	VPC Peering Connection "delete()" calls wrong method The "delete()" method of VpcPeeringConnection calls "self.connection.delete_vpc(self.id)" instead of "self.connection.delete_vpc_peering_connection(self.id)" File: boto/vpc/vpc_peering_connection.py	[ { "content": "# Copyright (c) 2014 Skytap http://skytap.com/\n#\n# Permission is hereby granted, free of charge, to any person obtaining a\n# copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish, dis-\n# tribute, sublicense, and/or sell copies of the Software, and to permit\n# persons to whom the Software is furnished to do so, subject to the fol-\n# lowing conditions:\n#\n# The above copyright notice and this permission notice shall be included\n# in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\n# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-\n# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\n# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\n# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n# IN THE SOFTWARE.\n\n\"\"\"\nRepresents a VPC Peering Connection.\n\"\"\"\n\nfrom boto.ec2.ec2object import TaggedEC2Object\n\nclass VpcInfo(object):\n def __init__(self):\n \"\"\"\n Information on peer Vpc.\n \n :ivar id: The unique ID of peer Vpc.\n :ivar owner_id: Owner of peer Vpc.\n :ivar cidr_block: CIDR Block of peer Vpc.\n \"\"\"\n\n self.vpc_id = None\n self.owner_id = None\n self.cidr_block = None\n\n def __repr__(self):\n return 'VpcInfo:%s' % self.vpc_id\n\n def startElement(self, name, attrs, connection):\n pass\n\n def endElement(self, name, value, connection):\n if name == 'vpcId':\n self.vpc_id = value\n elif name == 'ownerId':\n self.owner_id = value\n elif name == 'cidrBlock':\n self.cidr_block = value\n else:\n setattr(self, name, value)\n\nclass VpcPeeringConnectionStatus(object):\n \"\"\"\n The status of VPC peering connection.\n\n :ivar code: The status of the VPC peering connection. Valid values are:\n\n * pending-acceptance\n * failed\n * expired\n * provisioning\n * active\n * deleted\n * rejected\n\n :ivar message: A message that provides more information about the status of the VPC peering connection, if applicable.\n \"\"\"\n def __init__(self, code=0, message=None):\n self.code = code\n self.message = message\n\n def __repr__(self):\n return '%s(%d)' % (self.code, self.message)\n\n def startElement(self, name, attrs, connection):\n pass\n\n def endElement(self, name, value, connection):\n if name == 'code':\n self.code = value\n elif name == 'message':\n self.message = value\n else:\n setattr(self, name, value)\n\n \n\nclass VpcPeeringConnection(TaggedEC2Object):\n\n def __init__(self, connection=None):\n \"\"\"\n Represents a VPC peering connection.\n\n :ivar id: The unique ID of the VPC peering connection.\n :ivar accepter_vpc_info: Information on peer Vpc.\n :ivar requester_vpc_info: Information on requester Vpc.\n :ivar expiration_time: The expiration date and time for the VPC peering connection.\n :ivar status_code: The status of the VPC peering connection.\n :ivar status_message: A message that provides more information about the status of the VPC peering connection, if applicable.\n \"\"\"\n super(VpcPeeringConnection, self).__init__(connection)\n self.id = None\n self.accepter_vpc_info = VpcInfo()\n self.requester_vpc_info = VpcInfo()\n self.expiration_time = None\n self._status = VpcPeeringConnectionStatus()\n\n @property\n def status_code(self):\n return self._status.code\n\n @property\n def status_message(self):\n return self._status.message\n\n def __repr__(self):\n return 'VpcPeeringConnection:%s' % self.id\n\n def startElement(self, name, attrs, connection):\n retval = super(VpcPeeringConnection, self).startElement(name, attrs, connection)\n if retval is not None:\n return retval\n \n if name == 'requesterVpcInfo':\n return self.requester_vpc_info\n elif name == 'accepterVpcInfo':\n return self.accepter_vpc_info\n elif name == 'status':\n return self._status\n\n return None\n\n def endElement(self, name, value, connection):\n if name == 'vpcPeeringConnectionId':\n self.id = value\n elif name == 'expirationTime':\n self.expiration_time = value\n else:\n setattr(self, name, value)\n\n def delete(self):\n return self.connection.delete_vpc(self.id)\n\n def _update(self, updated):\n self.__dict__.update(updated.__dict__)\n\n def update(self, validate=False, dry_run=False):\n vpc_peering_connection_list = self.connection.get_all_vpc_peering_connections(\n [self.id],\n dry_run=dry_run\n )\n if len(vpc_peering_connection_list):\n updated_vpc_peering_connection = vpc_peering_connection_list[0]\n self._update(updated_vpc_peering_connection)\n elif validate:\n raise ValueError('%s is not a valid VpcPeeringConnection ID' % (self.id,))\n return self.status_code\n", "path": "boto/vpc/vpc_peering_connection.py" } ]	[ { "content": "# Copyright (c) 2014 Skytap http://skytap.com/\n#\n# Permission is hereby granted, free of charge, to any person obtaining a\n# copy of this software and associated documentation files (the\n# \"Software\"), to deal in the Software without restriction, including\n# without limitation the rights to use, copy, modify, merge, publish, dis-\n# tribute, sublicense, and/or sell copies of the Software, and to permit\n# persons to whom the Software is furnished to do so, subject to the fol-\n# lowing conditions:\n#\n# The above copyright notice and this permission notice shall be included\n# in all copies or substantial portions of the Software.\n#\n# THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS\n# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-\n# ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT\n# SHALL THE AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\n# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n# IN THE SOFTWARE.\n\n\"\"\"\nRepresents a VPC Peering Connection.\n\"\"\"\n\nfrom boto.ec2.ec2object import TaggedEC2Object\n\nclass VpcInfo(object):\n def __init__(self):\n \"\"\"\n Information on peer Vpc.\n \n :ivar id: The unique ID of peer Vpc.\n :ivar owner_id: Owner of peer Vpc.\n :ivar cidr_block: CIDR Block of peer Vpc.\n \"\"\"\n\n self.vpc_id = None\n self.owner_id = None\n self.cidr_block = None\n\n def __repr__(self):\n return 'VpcInfo:%s' % self.vpc_id\n\n def startElement(self, name, attrs, connection):\n pass\n\n def endElement(self, name, value, connection):\n if name == 'vpcId':\n self.vpc_id = value\n elif name == 'ownerId':\n self.owner_id = value\n elif name == 'cidrBlock':\n self.cidr_block = value\n else:\n setattr(self, name, value)\n\nclass VpcPeeringConnectionStatus(object):\n \"\"\"\n The status of VPC peering connection.\n\n :ivar code: The status of the VPC peering connection. Valid values are:\n\n * pending-acceptance\n * failed\n * expired\n * provisioning\n * active\n * deleted\n * rejected\n\n :ivar message: A message that provides more information about the status of the VPC peering connection, if applicable.\n \"\"\"\n def __init__(self, code=0, message=None):\n self.code = code\n self.message = message\n\n def __repr__(self):\n return '%s(%d)' % (self.code, self.message)\n\n def startElement(self, name, attrs, connection):\n pass\n\n def endElement(self, name, value, connection):\n if name == 'code':\n self.code = value\n elif name == 'message':\n self.message = value\n else:\n setattr(self, name, value)\n\n \n\nclass VpcPeeringConnection(TaggedEC2Object):\n\n def __init__(self, connection=None):\n \"\"\"\n Represents a VPC peering connection.\n\n :ivar id: The unique ID of the VPC peering connection.\n :ivar accepter_vpc_info: Information on peer Vpc.\n :ivar requester_vpc_info: Information on requester Vpc.\n :ivar expiration_time: The expiration date and time for the VPC peering connection.\n :ivar status_code: The status of the VPC peering connection.\n :ivar status_message: A message that provides more information about the status of the VPC peering connection, if applicable.\n \"\"\"\n super(VpcPeeringConnection, self).__init__(connection)\n self.id = None\n self.accepter_vpc_info = VpcInfo()\n self.requester_vpc_info = VpcInfo()\n self.expiration_time = None\n self._status = VpcPeeringConnectionStatus()\n\n @property\n def status_code(self):\n return self._status.code\n\n @property\n def status_message(self):\n return self._status.message\n\n def __repr__(self):\n return 'VpcPeeringConnection:%s' % self.id\n\n def startElement(self, name, attrs, connection):\n retval = super(VpcPeeringConnection, self).startElement(name, attrs, connection)\n if retval is not None:\n return retval\n \n if name == 'requesterVpcInfo':\n return self.requester_vpc_info\n elif name == 'accepterVpcInfo':\n return self.accepter_vpc_info\n elif name == 'status':\n return self._status\n\n return None\n\n def endElement(self, name, value, connection):\n if name == 'vpcPeeringConnectionId':\n self.id = value\n elif name == 'expirationTime':\n self.expiration_time = value\n else:\n setattr(self, name, value)\n\n def delete(self):\n return self.connection.delete_vpc_peering_connection(self.id)\n\n def _update(self, updated):\n self.__dict__.update(updated.__dict__)\n\n def update(self, validate=False, dry_run=False):\n vpc_peering_connection_list = self.connection.get_all_vpc_peering_connections(\n [self.id],\n dry_run=dry_run\n )\n if len(vpc_peering_connection_list):\n updated_vpc_peering_connection = vpc_peering_connection_list[0]\n self._update(updated_vpc_peering_connection)\n elif validate:\n raise ValueError('%s is not a valid VpcPeeringConnection ID' % (self.id,))\n return self.status_code\n", "path": "boto/vpc/vpc_peering_connection.py" } ]	diff --git a/boto/vpc/vpc_peering_connection.py b/boto/vpc/vpc_peering_connection.py index d7c11e8e59..cdb9af8dae 100644 --- a/boto/vpc/vpc_peering_connection.py +++ b/boto/vpc/vpc_peering_connection.py @@ -145,7 +145,7 @@ def endElement(self, name, value, connection): setattr(self, name, value) def delete(self): - return self.connection.delete_vpc(self.id) + return self.connection.delete_vpc_peering_connection(self.id) def _update(self, updated): self.__dict__.update(updated.__dict__) diff --git a/tests/unit/vpc/test_vpc_peering_connection.py b/tests/unit/vpc/test_vpc_peering_connection.py index 42e68d44dc..503e560654 100644 --- a/tests/unit/vpc/test_vpc_peering_connection.py +++ b/tests/unit/vpc/test_vpc_peering_connection.py @@ -19,7 +19,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS # IN THE SOFTWARE. -from tests.unit import unittest +from tests.unit import mock, unittest from tests.unit import AWSMockServiceTestCase from boto.vpc import VpcPeeringConnection, VPCConnection, Subnet @@ -159,6 +159,58 @@ def test_delete_vpc_peering_connection(self): self.set_http_response(status_code=200) self.assertEquals(self.service_connection.delete_vpc_peering_connection('pcx-12345678'), True) +class TestDeleteVpcPeeringConnectionShortForm(unittest.TestCase): + DESCRIBE_VPC_PEERING_CONNECTIONS= b"""<?xml version="1.0" encoding="UTF-8"?> +<DescribeVpcPeeringConnectionsResponse xmlns="http://ec2.amazonaws.com/doc/2014-05-01/"> + <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> + <vpcPeeringConnectionSet> + <item> + <vpcPeeringConnectionId>pcx-111aaa22</vpcPeeringConnectionId> + <requesterVpcInfo> + <ownerId>777788889999</ownerId> + <vpcId>vpc-1a2b3c4d</vpcId> + <cidrBlock>172.31.0.0/16</cidrBlock> + </requesterVpcInfo> + <accepterVpcInfo> + <ownerId>111122223333</ownerId> + <vpcId>vpc-aa22cc33</vpcId> + </accepterVpcInfo> + <status> + <code>pending-acceptance</code> + <message>Pending Acceptance by 111122223333</message> + </status> + <expirationTime>2014-02-17T16:00:50.000Z</expirationTime> + </item> + </vpcPeeringConnectionSet> +</DescribeVpcPeeringConnectionsResponse>""" + + DELETE_VPC_PEERING_CONNECTION= b"""<DeleteVpcPeeringConnectionResponse xmlns="http://ec2.amazonaws.com/doc/2014-05-01/"> + <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId> + <return>true</return> +</DeleteVpcPeeringConnectionResponse>""" + + def test_delete_vpc_peering_connection(self): + vpc_conn = VPCConnection(aws_access_key_id='aws_access_key_id', + aws_secret_access_key='aws_secret_access_key') + + mock_response = mock.Mock() + mock_response.read.return_value = self.DESCRIBE_VPC_PEERING_CONNECTIONS + mock_response.status = 200 + vpc_conn.make_request = mock.Mock(return_value=mock_response) + vpc_peering_connections = vpc_conn.get_all_vpc_peering_connections() + + self.assertEquals(1, len(vpc_peering_connections)) + vpc_peering_connection = vpc_peering_connections[0] + + mock_response = mock.Mock() + mock_response.read.return_value = self.DELETE_VPC_PEERING_CONNECTION + mock_response.status = 200 + vpc_conn.make_request = mock.Mock(return_value=mock_response) + self.assertEquals(True, vpc_peering_connection.delete()) + + self.assertIn('DeleteVpcPeeringConnection', vpc_conn.make_request.call_args_list[0][0]) + self.assertNotIn('DeleteVpc', vpc_conn.make_request.call_args_list[0][0]) + class TestRejectVpcPeeringConnection(AWSMockServiceTestCase): REJECT_VPC_PEERING_CONNECTION= b"""<RejectVpcPeeringConnectionResponse xmlns="http://ec2.amazonaws.com/doc/2014-05-01/"> <requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
ManimCommunity__manim-2328	Fade animation blends with background color, even if background is transparent ## Description of bug / unexpected behavior When playing a FadeOut animation on an MObject, the color of the object interpolates to the background color even when the background is transparent. I encountered this bug when compositing a PNG image sequence, output from Manim, with a separate background. ## Expected behavior The MObject should remain the same color, and simply reduce in opacity over time. ## How to reproduce the issue Setting the background color to purple makes the issue clearer. But it's still an issue, even with a black background. ```py def construct(self): self.camera.background_color = "#662266" fadeOutTest = Tex("Fading") self.play(FadeOut(fadeOutTest)) ``` And I rendered the image sequence with the flags --format png and -t ## Additional media files I put the resulting rendered image over a white background in a image editor so you can see the effect. Here is the image at the start of the animation. Interestingly, you can already see the blending happening around the edges due to anti-aliasing. ![StartOfFade](https://user-images.githubusercontent.com/13613122/140630850-ffd82e91-12e3-49d8-8a48-9ea31c93b7ed.png) And here is the same animation about halfway through. ![MiddleOfFade](https://user-images.githubusercontent.com/13613122/140630872-6e06486a-aa55-4b8a-9a46-0e700b4917f2.png) ## Notes: I did a little digging in the Manim codebase, and I believe this behavior is caused by the Cairo library. So I couldn't really figure out what to do about it. But maybe one of you guys has an idea?	[ { "content": "\"\"\"Colors and utility functions for conversion between different color models.\"\"\"\n\n__all__ = [\n \"color_to_rgb\",\n \"color_to_rgba\",\n \"rgb_to_color\",\n \"rgba_to_color\",\n \"rgb_to_hex\",\n \"hex_to_rgb\",\n \"invert_color\",\n \"color_to_int_rgb\",\n \"color_to_int_rgba\",\n \"color_gradient\",\n \"interpolate_color\",\n \"average_color\",\n \"random_bright_color\",\n \"random_color\",\n \"get_shaded_rgb\",\n]\n\nimport random\nfrom enum import Enum\nfrom typing import Iterable, List, Union\n\nimport numpy as np\nfrom colour import Color\n\nfrom ..utils.bezier import interpolate\nfrom ..utils.simple_functions import clip_in_place\nfrom ..utils.space_ops import normalize\n\n\nclass Colors(Enum):\n \"\"\"A list of pre-defined colors.\n\n Examples\n --------\n\n .. manim:: ColorsOverview\n :save_last_frame:\n :hide_source:\n\n from manim.utils.color import Colors\n class ColorsOverview(Scene):\n def construct(self):\n def color_group(color):\n group = VGroup(\n [\n Line(ORIGIN, RIGHT 1.5, stroke_width=35, color=Colors[name].value)\n for name in subnames(color)\n ]\n ).arrange_submobjects(buff=0.4, direction=DOWN)\n\n name = Text(color).scale(0.6).next_to(group, UP, buff=0.3)\n if any(decender in color for decender in \"gjpqy\"):\n name.shift(DOWN * 0.08)\n group.add(name)\n return group\n\n def subnames(name):\n return [name + \"_\" + char for char in \"abcde\"]\n\n color_groups = VGroup(\n [\n color_group(color)\n for color in [\n \"blue\",\n \"teal\",\n \"green\",\n \"yellow\",\n \"gold\",\n \"red\",\n \"maroon\",\n \"purple\",\n ]\n ]\n ).arrange_submobjects(buff=0.2, aligned_edge=DOWN)\n\n for line, char in zip(color_groups[0], \"abcde\"):\n color_groups.add(Text(char).scale(0.6).next_to(line, LEFT, buff=0.2))\n\n def named_lines_group(length, colors, names, text_colors, align_to_block):\n lines = VGroup(\n [\n Line(\n ORIGIN,\n RIGHT * length,\n stroke_width=55,\n color=Colors[color].value,\n )\n for color in colors\n ]\n ).arrange_submobjects(buff=0.6, direction=DOWN)\n\n for line, name, color in zip(lines, names, text_colors):\n line.add(Text(name, color=color).scale(0.6).move_to(line))\n lines.next_to(color_groups, DOWN, buff=0.5).align_to(\n color_groups[align_to_block], LEFT\n )\n return lines\n\n other_colors = (\n \"pink\",\n \"light_pink\",\n \"orange\",\n \"light_brown\",\n \"dark_brown\",\n \"gray_brown\",\n )\n\n other_lines = named_lines_group(\n 3.2,\n other_colors,\n other_colors,\n [BLACK] * 4 + [WHITE] * 2,\n 0,\n )\n\n gray_lines = named_lines_group(\n 6.6,\n [\"white\"] + subnames(\"gray\") + [\"black\"],\n [\n \"white\",\n \"lighter_gray / gray_a\",\n \"light_gray / gray_b\",\n \"gray / gray_c\",\n \"dark_gray / gray_d\",\n \"darker_gray / gray_e\",\n \"black\",\n ],\n [BLACK] * 3 + [WHITE] * 4,\n 2,\n )\n\n pure_colors = (\n \"pure_red\",\n \"pure_green\",\n \"pure_blue\",\n )\n\n pure_lines = named_lines_group(\n 3.2,\n pure_colors,\n pure_colors,\n [BLACK, BLACK, WHITE],\n 6,\n )\n\n self.add(color_groups, other_lines, gray_lines, pure_lines)\n\n VGroup(self.mobjects).move_to(ORIGIN)\n\n\n The preferred way of using these colors is by importing their constants from manim:\n\n .. code-block:: pycon\n\n >>> from manim import RED, GREEN, BLUE\n >>> RED\n '#FC6255'\n\n Note this way uses the name of the colors in UPPERCASE.\n\n Alternatively, you can also import this Enum directly and use its members\n directly, through the use of :code:`color.value`. Note this way uses the\n name of the colors in lowercase.\n\n .. code-block:: pycon\n\n >>> from manim.utils.color import Colors\n >>> Colors.red.value\n '#FC6255'\n\n .. note::\n\n The colors of type \"C\" have an alias equal to the colorname without a letter,\n e.g. GREEN = GREEN_C\n\n \"\"\"\n\n white: str = \"#FFFFFF\"\n gray_a: str = \"#DDDDDD\"\n gray_b: str = \"#BBBBBB\"\n gray_c: str = \"#888888\"\n gray_d: str = \"#444444\"\n gray_e: str = \"#222222\"\n black: str = \"#000000\"\n lighter_gray: str = gray_a\n light_gray: str = gray_b\n gray: str = gray_c\n dark_gray: str = gray_d\n darker_gray: str = gray_e\n\n blue_a: str = \"#C7E9F1\"\n blue_b: str = \"#9CDCEB\"\n blue_c: str = \"#58C4DD\"\n blue_d: str = \"#29ABCA\"\n blue_e: str = \"#236B8E\"\n pure_blue: str = \"#0000FF\"\n blue: str = blue_c\n dark_blue: str = blue_e\n\n teal_a: str = \"#ACEAD7\"\n teal_b: str = \"#76DDC0\"\n teal_c: str = \"#5CD0B3\"\n teal_d: str = \"#55C1A7\"\n teal_e: str = \"#49A88F\"\n teal: str = teal_c\n\n green_a: str = \"#C9E2AE\"\n green_b: str = \"#A6CF8C\"\n green_c: str = \"#83C167\"\n green_d: str = \"#77B05D\"\n green_e: str = \"#699C52\"\n pure_green: str = \"#00FF00\"\n green: str = green_c\n\n yellow_a: str = \"#FFF1B6\"\n yellow_b: str = \"#FFEA94\"\n yellow_c: str = \"#FFFF00\"\n yellow_d: str = \"#F4D345\"\n yellow_e: str = \"#E8C11C\"\n yellow: str = yellow_c\n\n gold_a: str = \"#F7C797\"\n gold_b: str = \"#F9B775\"\n gold_c: str = \"#F0AC5F\"\n gold_d: str = \"#E1A158\"\n gold_e: str = \"#C78D46\"\n gold: str = gold_c\n\n red_a: str = \"#F7A1A3\"\n red_b: str = \"#FF8080\"\n red_c: str = \"#FC6255\"\n red_d: str = \"#E65A4C\"\n red_e: str = \"#CF5044\"\n pure_red: str = \"#FF0000\"\n red: str = red_c\n\n maroon_a: str = \"#ECABC1\"\n maroon_b: str = \"#EC92AB\"\n maroon_c: str = \"#C55F73\"\n maroon_d: str = \"#A24D61\"\n maroon_e: str = \"#94424F\"\n maroon: str = maroon_c\n\n purple_a: str = \"#CAA3E8\"\n purple_b: str = \"#B189C6\"\n purple_c: str = \"#9A72AC\"\n purple_d: str = \"#715582\"\n purple_e: str = \"#644172\"\n purple: str = purple_c\n\n pink: str = \"#D147BD\"\n light_pink: str = \"#DC75CD\"\n\n orange: str = \"#FF862F\"\n light_brown: str = \"#CD853F\"\n dark_brown: str = \"#8B4513\"\n gray_brown: str = \"#736357\"\n\n\ndef print_constant_definitions():\n \"\"\"\n A simple function used to generate the constant values below. To run it\n paste this function and the Colors class into a file and run them.\n \"\"\"\n constants_names: list[str] = []\n for name in Colors.__members__.keys():\n name_upper = name.upper()\n\n constants_names.append(name_upper)\n print(f\"{name_upper} = Colors.{name}\")\n\n if \"GRAY\" in name_upper:\n name_upper = name_upper.replace(\"GRAY\", \"GREY\")\n\n constants_names.append(name_upper)\n print(f\"{name_upper} = Colors.{name}\")\n\n constants_names_repr = '[\\n \"' + '\",\\n \"'.join(constants_names) + '\",\\n]'\n\n print(f\"\\n__all__ += {constants_names_repr}\")\n\n\nWHITE: str = \"#FFFFFF\"\nGRAY_A: str = \"#DDDDDD\"\nGREY_A: str = \"#DDDDDD\"\nGRAY_B: str = \"#BBBBBB\"\nGREY_B: str = \"#BBBBBB\"\nGRAY_C: str = \"#888888\"\nGREY_C: str = \"#888888\"\nGRAY_D: str = \"#444444\"\nGREY_D: str = \"#444444\"\nGRAY_E: str = \"#222222\"\nGREY_E: str = \"#222222\"\nBLACK: str = \"#000000\"\nLIGHTER_GRAY: str = \"#DDDDDD\"\nLIGHTER_GREY: str = \"#DDDDDD\"\nLIGHT_GRAY: str = \"#BBBBBB\"\nLIGHT_GREY: str = \"#BBBBBB\"\nGRAY: str = \"#888888\"\nGREY: str = \"#888888\"\nDARK_GRAY: str = \"#444444\"\nDARK_GREY: str = \"#444444\"\nDARKER_GRAY: str = \"#222222\"\nDARKER_GREY: str = \"#222222\"\nBLUE_A: str = \"#C7E9F1\"\nBLUE_B: str = \"#9CDCEB\"\nBLUE_C: str = \"#58C4DD\"\nBLUE_D: str = \"#29ABCA\"\nBLUE_E: str = \"#236B8E\"\nPURE_BLUE: str = \"#0000FF\"\nBLUE: str = \"#58C4DD\"\nDARK_BLUE: str = \"#236B8E\"\nTEAL_A: str = \"#ACEAD7\"\nTEAL_B: str = \"#76DDC0\"\nTEAL_C: str = \"#5CD0B3\"\nTEAL_D: str = \"#55C1A7\"\nTEAL_E: str = \"#49A88F\"\nTEAL: str = \"#5CD0B3\"\nGREEN_A: str = \"#C9E2AE\"\nGREEN_B: str = \"#A6CF8C\"\nGREEN_C: str = \"#83C167\"\nGREEN_D: str = \"#77B05D\"\nGREEN_E: str = \"#699C52\"\nPURE_GREEN: str = \"#00FF00\"\nGREEN: str = \"#83C167\"\nYELLOW_A: str = \"#FFF1B6\"\nYELLOW_B: str = \"#FFEA94\"\nYELLOW_C: str = \"#FFFF00\"\nYELLOW_D: str = \"#F4D345\"\nYELLOW_E: str = \"#E8C11C\"\nYELLOW: str = \"#FFFF00\"\nGOLD_A: str = \"#F7C797\"\nGOLD_B: str = \"#F9B775\"\nGOLD_C: str = \"#F0AC5F\"\nGOLD_D: str = \"#E1A158\"\nGOLD_E: str = \"#C78D46\"\nGOLD: str = \"#F0AC5F\"\nRED_A: str = \"#F7A1A3\"\nRED_B: str = \"#FF8080\"\nRED_C: str = \"#FC6255\"\nRED_D: str = \"#E65A4C\"\nRED_E: str = \"#CF5044\"\nPURE_RED: str = \"#FF0000\"\nRED: str = \"#FC6255\"\nMAROON_A: str = \"#ECABC1\"\nMAROON_B: str = \"#EC92AB\"\nMAROON_C: str = \"#C55F73\"\nMAROON_D: str = \"#A24D61\"\nMAROON_E: str = \"#94424F\"\nMAROON: str = \"#C55F73\"\nPURPLE_A: str = \"#CAA3E8\"\nPURPLE_B: str = \"#B189C6\"\nPURPLE_C: str = \"#9A72AC\"\nPURPLE_D: str = \"#715582\"\nPURPLE_E: str = \"#644172\"\nPURPLE: str = \"#9A72AC\"\nPINK: str = \"#D147BD\"\nLIGHT_PINK: str = \"#DC75CD\"\nORANGE: str = \"#FF862F\"\nLIGHT_BROWN: str = \"#CD853F\"\nDARK_BROWN: str = \"#8B4513\"\nGRAY_BROWN: str = \"#736357\"\nGREY_BROWN: str = \"#736357\"\n\n__all__ += [\n \"WHITE\",\n \"GRAY_A\",\n \"GREY_A\",\n \"GRAY_B\",\n \"GREY_B\",\n \"GRAY_C\",\n \"GREY_C\",\n \"GRAY_D\",\n \"GREY_D\",\n \"GRAY_E\",\n \"GREY_E\",\n \"BLACK\",\n \"LIGHTER_GRAY\",\n \"LIGHTER_GREY\",\n \"LIGHT_GRAY\",\n \"LIGHT_GREY\",\n \"GRAY\",\n \"GREY\",\n \"DARK_GRAY\",\n \"DARK_GREY\",\n \"DARKER_GRAY\",\n \"DARKER_GREY\",\n \"BLUE_A\",\n \"BLUE_B\",\n \"BLUE_C\",\n \"BLUE_D\",\n \"BLUE_E\",\n \"PURE_BLUE\",\n \"BLUE\",\n \"DARK_BLUE\",\n \"TEAL_A\",\n \"TEAL_B\",\n \"TEAL_C\",\n \"TEAL_D\",\n \"TEAL_E\",\n \"TEAL\",\n \"GREEN_A\",\n \"GREEN_B\",\n \"GREEN_C\",\n \"GREEN_D\",\n \"GREEN_E\",\n \"PURE_GREEN\",\n \"GREEN\",\n \"YELLOW_A\",\n \"YELLOW_B\",\n \"YELLOW_C\",\n \"YELLOW_D\",\n \"YELLOW_E\",\n \"YELLOW\",\n \"GOLD_A\",\n \"GOLD_B\",\n \"GOLD_C\",\n \"GOLD_D\",\n \"GOLD_E\",\n \"GOLD\",\n \"RED_A\",\n \"RED_B\",\n \"RED_C\",\n \"RED_D\",\n \"RED_E\",\n \"PURE_RED\",\n \"RED\",\n \"MAROON_A\",\n \"MAROON_B\",\n \"MAROON_C\",\n \"MAROON_D\",\n \"MAROON_E\",\n \"MAROON\",\n \"PURPLE_A\",\n \"PURPLE_B\",\n \"PURPLE_C\",\n \"PURPLE_D\",\n \"PURPLE_E\",\n \"PURPLE\",\n \"PINK\",\n \"LIGHT_PINK\",\n \"ORANGE\",\n \"LIGHT_BROWN\",\n \"DARK_BROWN\",\n \"GRAY_BROWN\",\n \"GREY_BROWN\",\n]\n\n\ndef color_to_rgb(color: Union[Color, str]) -> np.ndarray:\n if isinstance(color, str):\n return hex_to_rgb(color)\n elif isinstance(color, Color):\n return np.array(color.get_rgb())\n else:\n raise ValueError(\"Invalid color type: \" + str(color))\n\n\ndef color_to_rgba(color: Union[Color, str], alpha: float = 1) -> np.ndarray:\n return np.array([color_to_rgb(color), alpha])\n\n\ndef rgb_to_color(rgb: Iterable[float]) -> Color:\n return Color(rgb=rgb)\n\n\ndef rgba_to_color(rgba: Iterable[float]) -> Color:\n return rgb_to_color(rgba[:3])\n\n\ndef rgb_to_hex(rgb: Iterable[float]) -> str:\n return \"#\" + \"\".join(\"%02x\" % int(255 * x) for x in rgb)\n\n\ndef hex_to_rgb(hex_code: str) -> np.ndarray:\n hex_part = hex_code[1:]\n if len(hex_part) == 3:\n hex_part = \"\".join([2 * c for c in hex_part])\n return np.array([int(hex_part[i : i + 2], 16) / 255 for i in range(0, 6, 2)])\n\n\ndef invert_color(color: Color) -> Color:\n return rgb_to_color(1.0 - color_to_rgb(color))\n\n\ndef color_to_int_rgb(color: Color) -> np.ndarray:\n return (255 * color_to_rgb(color)).astype(\"uint8\")\n\n\ndef color_to_int_rgba(color: Color, opacity: float = 1.0) -> np.ndarray:\n alpha = int(255 * opacity)\n return np.append(color_to_int_rgb(color), alpha)\n\n\ndef color_gradient(\n reference_colors: Iterable[Color],\n length_of_output: int,\n) -> List[Color]:\n if length_of_output == 0:\n return reference_colors[0]\n rgbs = list(map(color_to_rgb, reference_colors))\n alphas = np.linspace(0, (len(rgbs) - 1), length_of_output)\n floors = alphas.astype(\"int\")\n alphas_mod1 = alphas % 1\n # End edge case\n alphas_mod1[-1] = 1\n floors[-1] = len(rgbs) - 2\n return [\n rgb_to_color(interpolate(rgbs[i], rgbs[i + 1], alpha))\n for i, alpha in zip(floors, alphas_mod1)\n ]\n\n\ndef interpolate_color(color1: Color, color2: Color, alpha: float) -> Color:\n rgb = interpolate(color_to_rgb(color1), color_to_rgb(color2), alpha)\n return rgb_to_color(rgb)\n\n\ndef average_color(colors: Color) -> Color:\n rgbs = np.array(list(map(color_to_rgb, colors)))\n mean_rgb = np.apply_along_axis(np.mean, 0, rgbs)\n return rgb_to_color(mean_rgb)\n\n\ndef random_bright_color() -> Color:\n color = random_color()\n curr_rgb = color_to_rgb(color)\n new_rgb = interpolate(curr_rgb, np.ones(len(curr_rgb)), 0.5)\n return Color(rgb=new_rgb)\n\n\ndef random_color() -> Color:\n return random.choice([c.value for c in list(Colors)])\n\n\ndef get_shaded_rgb(\n rgb: np.ndarray,\n point: np.ndarray,\n unit_normal_vect: np.ndarray,\n light_source: np.ndarray,\n) -> np.ndarray:\n to_sun = normalize(light_source - point)\n factor = 0.5 np.dot(unit_normal_vect, to_sun) ** 3\n if factor < 0:\n factor *= 0.5\n result = rgb + factor\n clip_in_place(rgb + factor, 0, 1)\n return result\n", "path": "manim/utils/color.py" } ]	[ { "content": "\"\"\"Colors and utility functions for conversion between different color models.\"\"\"\n\n__all__ = [\n \"color_to_rgb\",\n \"color_to_rgba\",\n \"rgb_to_color\",\n \"rgba_to_color\",\n \"rgb_to_hex\",\n \"hex_to_rgb\",\n \"invert_color\",\n \"color_to_int_rgb\",\n \"color_to_int_rgba\",\n \"color_gradient\",\n \"interpolate_color\",\n \"average_color\",\n \"random_bright_color\",\n \"random_color\",\n \"get_shaded_rgb\",\n]\n\nimport random\nfrom enum import Enum\nfrom typing import Iterable, List, Union\n\nimport numpy as np\nfrom colour import Color\n\nfrom ..utils.bezier import interpolate\nfrom ..utils.simple_functions import clip_in_place\nfrom ..utils.space_ops import normalize\n\n\nclass Colors(Enum):\n \"\"\"A list of pre-defined colors.\n\n Examples\n --------\n\n .. manim:: ColorsOverview\n :save_last_frame:\n :hide_source:\n\n from manim.utils.color import Colors\n class ColorsOverview(Scene):\n def construct(self):\n def color_group(color):\n group = VGroup(\n [\n Line(ORIGIN, RIGHT 1.5, stroke_width=35, color=Colors[name].value)\n for name in subnames(color)\n ]\n ).arrange_submobjects(buff=0.4, direction=DOWN)\n\n name = Text(color).scale(0.6).next_to(group, UP, buff=0.3)\n if any(decender in color for decender in \"gjpqy\"):\n name.shift(DOWN * 0.08)\n group.add(name)\n return group\n\n def subnames(name):\n return [name + \"_\" + char for char in \"abcde\"]\n\n color_groups = VGroup(\n [\n color_group(color)\n for color in [\n \"blue\",\n \"teal\",\n \"green\",\n \"yellow\",\n \"gold\",\n \"red\",\n \"maroon\",\n \"purple\",\n ]\n ]\n ).arrange_submobjects(buff=0.2, aligned_edge=DOWN)\n\n for line, char in zip(color_groups[0], \"abcde\"):\n color_groups.add(Text(char).scale(0.6).next_to(line, LEFT, buff=0.2))\n\n def named_lines_group(length, colors, names, text_colors, align_to_block):\n lines = VGroup(\n [\n Line(\n ORIGIN,\n RIGHT * length,\n stroke_width=55,\n color=Colors[color].value,\n )\n for color in colors\n ]\n ).arrange_submobjects(buff=0.6, direction=DOWN)\n\n for line, name, color in zip(lines, names, text_colors):\n line.add(Text(name, color=color).scale(0.6).move_to(line))\n lines.next_to(color_groups, DOWN, buff=0.5).align_to(\n color_groups[align_to_block], LEFT\n )\n return lines\n\n other_colors = (\n \"pink\",\n \"light_pink\",\n \"orange\",\n \"light_brown\",\n \"dark_brown\",\n \"gray_brown\",\n )\n\n other_lines = named_lines_group(\n 3.2,\n other_colors,\n other_colors,\n [BLACK] * 4 + [WHITE] * 2,\n 0,\n )\n\n gray_lines = named_lines_group(\n 6.6,\n [\"white\"] + subnames(\"gray\") + [\"black\"],\n [\n \"white\",\n \"lighter_gray / gray_a\",\n \"light_gray / gray_b\",\n \"gray / gray_c\",\n \"dark_gray / gray_d\",\n \"darker_gray / gray_e\",\n \"black\",\n ],\n [BLACK] * 3 + [WHITE] * 4,\n 2,\n )\n\n pure_colors = (\n \"pure_red\",\n \"pure_green\",\n \"pure_blue\",\n )\n\n pure_lines = named_lines_group(\n 3.2,\n pure_colors,\n pure_colors,\n [BLACK, BLACK, WHITE],\n 6,\n )\n\n self.add(color_groups, other_lines, gray_lines, pure_lines)\n\n VGroup(self.mobjects).move_to(ORIGIN)\n\n\n The preferred way of using these colors is by importing their constants from manim:\n\n .. code-block:: pycon\n\n >>> from manim import RED, GREEN, BLUE\n >>> RED\n '#FC6255'\n\n Note this way uses the name of the colors in UPPERCASE.\n\n Alternatively, you can also import this Enum directly and use its members\n directly, through the use of :code:`color.value`. Note this way uses the\n name of the colors in lowercase.\n\n .. code-block:: pycon\n\n >>> from manim.utils.color import Colors\n >>> Colors.red.value\n '#FC6255'\n\n .. note::\n\n The colors of type \"C\" have an alias equal to the colorname without a letter,\n e.g. GREEN = GREEN_C\n\n \"\"\"\n\n white: str = \"#FFFFFF\"\n gray_a: str = \"#DDDDDD\"\n gray_b: str = \"#BBBBBB\"\n gray_c: str = \"#888888\"\n gray_d: str = \"#444444\"\n gray_e: str = \"#222222\"\n black: str = \"#000000\"\n lighter_gray: str = gray_a\n light_gray: str = gray_b\n gray: str = gray_c\n dark_gray: str = gray_d\n darker_gray: str = gray_e\n\n blue_a: str = \"#C7E9F1\"\n blue_b: str = \"#9CDCEB\"\n blue_c: str = \"#58C4DD\"\n blue_d: str = \"#29ABCA\"\n blue_e: str = \"#236B8E\"\n pure_blue: str = \"#0000FF\"\n blue: str = blue_c\n dark_blue: str = blue_e\n\n teal_a: str = \"#ACEAD7\"\n teal_b: str = \"#76DDC0\"\n teal_c: str = \"#5CD0B3\"\n teal_d: str = \"#55C1A7\"\n teal_e: str = \"#49A88F\"\n teal: str = teal_c\n\n green_a: str = \"#C9E2AE\"\n green_b: str = \"#A6CF8C\"\n green_c: str = \"#83C167\"\n green_d: str = \"#77B05D\"\n green_e: str = \"#699C52\"\n pure_green: str = \"#00FF00\"\n green: str = green_c\n\n yellow_a: str = \"#FFF1B6\"\n yellow_b: str = \"#FFEA94\"\n yellow_c: str = \"#FFFF00\"\n yellow_d: str = \"#F4D345\"\n yellow_e: str = \"#E8C11C\"\n yellow: str = yellow_c\n\n gold_a: str = \"#F7C797\"\n gold_b: str = \"#F9B775\"\n gold_c: str = \"#F0AC5F\"\n gold_d: str = \"#E1A158\"\n gold_e: str = \"#C78D46\"\n gold: str = gold_c\n\n red_a: str = \"#F7A1A3\"\n red_b: str = \"#FF8080\"\n red_c: str = \"#FC6255\"\n red_d: str = \"#E65A4C\"\n red_e: str = \"#CF5044\"\n pure_red: str = \"#FF0000\"\n red: str = red_c\n\n maroon_a: str = \"#ECABC1\"\n maroon_b: str = \"#EC92AB\"\n maroon_c: str = \"#C55F73\"\n maroon_d: str = \"#A24D61\"\n maroon_e: str = \"#94424F\"\n maroon: str = maroon_c\n\n purple_a: str = \"#CAA3E8\"\n purple_b: str = \"#B189C6\"\n purple_c: str = \"#9A72AC\"\n purple_d: str = \"#715582\"\n purple_e: str = \"#644172\"\n purple: str = purple_c\n\n pink: str = \"#D147BD\"\n light_pink: str = \"#DC75CD\"\n\n orange: str = \"#FF862F\"\n light_brown: str = \"#CD853F\"\n dark_brown: str = \"#8B4513\"\n gray_brown: str = \"#736357\"\n\n\ndef print_constant_definitions():\n \"\"\"\n A simple function used to generate the constant values below. To run it\n paste this function and the Colors class into a file and run them.\n \"\"\"\n constants_names: list[str] = []\n for name in Colors.__members__.keys():\n name_upper = name.upper()\n\n constants_names.append(name_upper)\n print(f\"{name_upper} = Colors.{name}\")\n\n if \"GRAY\" in name_upper:\n name_upper = name_upper.replace(\"GRAY\", \"GREY\")\n\n constants_names.append(name_upper)\n print(f\"{name_upper} = Colors.{name}\")\n\n constants_names_repr = '[\\n \"' + '\",\\n \"'.join(constants_names) + '\",\\n]'\n\n print(f\"\\n__all__ += {constants_names_repr}\")\n\n\nWHITE: str = \"#FFFFFF\"\nGRAY_A: str = \"#DDDDDD\"\nGREY_A: str = \"#DDDDDD\"\nGRAY_B: str = \"#BBBBBB\"\nGREY_B: str = \"#BBBBBB\"\nGRAY_C: str = \"#888888\"\nGREY_C: str = \"#888888\"\nGRAY_D: str = \"#444444\"\nGREY_D: str = \"#444444\"\nGRAY_E: str = \"#222222\"\nGREY_E: str = \"#222222\"\nBLACK: str = \"#000000\"\nLIGHTER_GRAY: str = \"#DDDDDD\"\nLIGHTER_GREY: str = \"#DDDDDD\"\nLIGHT_GRAY: str = \"#BBBBBB\"\nLIGHT_GREY: str = \"#BBBBBB\"\nGRAY: str = \"#888888\"\nGREY: str = \"#888888\"\nDARK_GRAY: str = \"#444444\"\nDARK_GREY: str = \"#444444\"\nDARKER_GRAY: str = \"#222222\"\nDARKER_GREY: str = \"#222222\"\nBLUE_A: str = \"#C7E9F1\"\nBLUE_B: str = \"#9CDCEB\"\nBLUE_C: str = \"#58C4DD\"\nBLUE_D: str = \"#29ABCA\"\nBLUE_E: str = \"#236B8E\"\nPURE_BLUE: str = \"#0000FF\"\nBLUE: str = \"#58C4DD\"\nDARK_BLUE: str = \"#236B8E\"\nTEAL_A: str = \"#ACEAD7\"\nTEAL_B: str = \"#76DDC0\"\nTEAL_C: str = \"#5CD0B3\"\nTEAL_D: str = \"#55C1A7\"\nTEAL_E: str = \"#49A88F\"\nTEAL: str = \"#5CD0B3\"\nGREEN_A: str = \"#C9E2AE\"\nGREEN_B: str = \"#A6CF8C\"\nGREEN_C: str = \"#83C167\"\nGREEN_D: str = \"#77B05D\"\nGREEN_E: str = \"#699C52\"\nPURE_GREEN: str = \"#00FF00\"\nGREEN: str = \"#83C167\"\nYELLOW_A: str = \"#FFF1B6\"\nYELLOW_B: str = \"#FFEA94\"\nYELLOW_C: str = \"#FFFF00\"\nYELLOW_D: str = \"#F4D345\"\nYELLOW_E: str = \"#E8C11C\"\nYELLOW: str = \"#FFFF00\"\nGOLD_A: str = \"#F7C797\"\nGOLD_B: str = \"#F9B775\"\nGOLD_C: str = \"#F0AC5F\"\nGOLD_D: str = \"#E1A158\"\nGOLD_E: str = \"#C78D46\"\nGOLD: str = \"#F0AC5F\"\nRED_A: str = \"#F7A1A3\"\nRED_B: str = \"#FF8080\"\nRED_C: str = \"#FC6255\"\nRED_D: str = \"#E65A4C\"\nRED_E: str = \"#CF5044\"\nPURE_RED: str = \"#FF0000\"\nRED: str = \"#FC6255\"\nMAROON_A: str = \"#ECABC1\"\nMAROON_B: str = \"#EC92AB\"\nMAROON_C: str = \"#C55F73\"\nMAROON_D: str = \"#A24D61\"\nMAROON_E: str = \"#94424F\"\nMAROON: str = \"#C55F73\"\nPURPLE_A: str = \"#CAA3E8\"\nPURPLE_B: str = \"#B189C6\"\nPURPLE_C: str = \"#9A72AC\"\nPURPLE_D: str = \"#715582\"\nPURPLE_E: str = \"#644172\"\nPURPLE: str = \"#9A72AC\"\nPINK: str = \"#D147BD\"\nLIGHT_PINK: str = \"#DC75CD\"\nORANGE: str = \"#FF862F\"\nLIGHT_BROWN: str = \"#CD853F\"\nDARK_BROWN: str = \"#8B4513\"\nGRAY_BROWN: str = \"#736357\"\nGREY_BROWN: str = \"#736357\"\n\n__all__ += [\n \"WHITE\",\n \"GRAY_A\",\n \"GREY_A\",\n \"GRAY_B\",\n \"GREY_B\",\n \"GRAY_C\",\n \"GREY_C\",\n \"GRAY_D\",\n \"GREY_D\",\n \"GRAY_E\",\n \"GREY_E\",\n \"BLACK\",\n \"LIGHTER_GRAY\",\n \"LIGHTER_GREY\",\n \"LIGHT_GRAY\",\n \"LIGHT_GREY\",\n \"GRAY\",\n \"GREY\",\n \"DARK_GRAY\",\n \"DARK_GREY\",\n \"DARKER_GRAY\",\n \"DARKER_GREY\",\n \"BLUE_A\",\n \"BLUE_B\",\n \"BLUE_C\",\n \"BLUE_D\",\n \"BLUE_E\",\n \"PURE_BLUE\",\n \"BLUE\",\n \"DARK_BLUE\",\n \"TEAL_A\",\n \"TEAL_B\",\n \"TEAL_C\",\n \"TEAL_D\",\n \"TEAL_E\",\n \"TEAL\",\n \"GREEN_A\",\n \"GREEN_B\",\n \"GREEN_C\",\n \"GREEN_D\",\n \"GREEN_E\",\n \"PURE_GREEN\",\n \"GREEN\",\n \"YELLOW_A\",\n \"YELLOW_B\",\n \"YELLOW_C\",\n \"YELLOW_D\",\n \"YELLOW_E\",\n \"YELLOW\",\n \"GOLD_A\",\n \"GOLD_B\",\n \"GOLD_C\",\n \"GOLD_D\",\n \"GOLD_E\",\n \"GOLD\",\n \"RED_A\",\n \"RED_B\",\n \"RED_C\",\n \"RED_D\",\n \"RED_E\",\n \"PURE_RED\",\n \"RED\",\n \"MAROON_A\",\n \"MAROON_B\",\n \"MAROON_C\",\n \"MAROON_D\",\n \"MAROON_E\",\n \"MAROON\",\n \"PURPLE_A\",\n \"PURPLE_B\",\n \"PURPLE_C\",\n \"PURPLE_D\",\n \"PURPLE_E\",\n \"PURPLE\",\n \"PINK\",\n \"LIGHT_PINK\",\n \"ORANGE\",\n \"LIGHT_BROWN\",\n \"DARK_BROWN\",\n \"GRAY_BROWN\",\n \"GREY_BROWN\",\n]\n\n\ndef color_to_rgb(color: Union[Color, str]) -> np.ndarray:\n if isinstance(color, str):\n return hex_to_rgb(color)\n elif isinstance(color, Color):\n return np.array(color.get_rgb())\n else:\n raise ValueError(\"Invalid color type: \" + str(color))\n\n\ndef color_to_rgba(color: Union[Color, str], alpha: float = 1) -> np.ndarray:\n return np.array([color_to_rgb(color), alpha])\n\n\ndef rgb_to_color(rgb: Iterable[float]) -> Color:\n return Color(rgb=rgb)\n\n\ndef rgba_to_color(rgba: Iterable[float]) -> Color:\n return rgb_to_color(rgba[:3])\n\n\ndef rgb_to_hex(rgb: Iterable[float]) -> str:\n return \"#\" + \"\".join(\"%02x\" % int(255 * x) for x in rgb)\n\n\ndef hex_to_rgb(hex_code: str) -> np.ndarray:\n hex_part = hex_code[1:]\n if len(hex_part) == 3:\n hex_part = \"\".join([2 * c for c in hex_part])\n return np.array([int(hex_part[i : i + 2], 16) / 255 for i in range(0, 6, 2)])\n\n\ndef invert_color(color: Color) -> Color:\n return rgb_to_color(1.0 - color_to_rgb(color))\n\n\ndef color_to_int_rgb(color: Color) -> np.ndarray:\n return (255 * color_to_rgb(color)).astype(\"uint8\")\n\n\ndef color_to_int_rgba(color: Color, opacity: float = 1.0) -> np.ndarray:\n alpha_multiplier = np.vectorize(lambda x: int(x * opacity))\n\n return alpha_multiplier(np.append(color_to_int_rgb(color), 255))\n\n\ndef color_gradient(\n reference_colors: Iterable[Color],\n length_of_output: int,\n) -> List[Color]:\n if length_of_output == 0:\n return reference_colors[0]\n rgbs = list(map(color_to_rgb, reference_colors))\n alphas = np.linspace(0, (len(rgbs) - 1), length_of_output)\n floors = alphas.astype(\"int\")\n alphas_mod1 = alphas % 1\n # End edge case\n alphas_mod1[-1] = 1\n floors[-1] = len(rgbs) - 2\n return [\n rgb_to_color(interpolate(rgbs[i], rgbs[i + 1], alpha))\n for i, alpha in zip(floors, alphas_mod1)\n ]\n\n\ndef interpolate_color(color1: Color, color2: Color, alpha: float) -> Color:\n rgb = interpolate(color_to_rgb(color1), color_to_rgb(color2), alpha)\n return rgb_to_color(rgb)\n\n\ndef average_color(colors: Color) -> Color:\n rgbs = np.array(list(map(color_to_rgb, colors)))\n mean_rgb = np.apply_along_axis(np.mean, 0, rgbs)\n return rgb_to_color(mean_rgb)\n\n\ndef random_bright_color() -> Color:\n color = random_color()\n curr_rgb = color_to_rgb(color)\n new_rgb = interpolate(curr_rgb, np.ones(len(curr_rgb)), 0.5)\n return Color(rgb=new_rgb)\n\n\ndef random_color() -> Color:\n return random.choice([c.value for c in list(Colors)])\n\n\ndef get_shaded_rgb(\n rgb: np.ndarray,\n point: np.ndarray,\n unit_normal_vect: np.ndarray,\n light_source: np.ndarray,\n) -> np.ndarray:\n to_sun = normalize(light_source - point)\n factor = 0.5 np.dot(unit_normal_vect, to_sun) ** 3\n if factor < 0:\n factor *= 0.5\n result = rgb + factor\n clip_in_place(rgb + factor, 0, 1)\n return result\n", "path": "manim/utils/color.py" } ]	diff --git a/manim/utils/color.py b/manim/utils/color.py index 30669fda59..fa48ac693f 100644 --- a/manim/utils/color.py +++ b/manim/utils/color.py @@ -491,8 +491,9 @@ def color_to_int_rgb(color: Color) -> np.ndarray: def color_to_int_rgba(color: Color, opacity: float = 1.0) -> np.ndarray: - alpha = int(255 * opacity) - return np.append(color_to_int_rgb(color), alpha) + alpha_multiplier = np.vectorize(lambda x: int(x * opacity)) + + return alpha_multiplier(np.append(color_to_int_rgb(color), 255)) def color_gradient( diff --git a/tests/test_color.py b/tests/test_color.py index 073c90d57a..dec03bf2a3 100644 --- a/tests/test_color.py +++ b/tests/test_color.py @@ -27,7 +27,7 @@ def test_background_color(): S.camera.background_color = "#bbffbb" S.camera.background_opacity = 0.5 S.renderer.update_frame(S) - assert np.all(S.renderer.get_frame()[0, 0] == np.array([187, 255, 187, 127])) + assert np.all(S.renderer.get_frame()[0, 0] == np.array([93, 127, 93, 127])) def test_set_color():
pallets__click-1695	Automatic short help should also take linebreak into account PEP257 defines a summary line for [multi-line docstrings](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings) just like a [one-line docstring](https://www.python.org/dev/peps/pep-0257/#one-line-docstrings) to be a phrase ending in a period. Click automatically uses everything up to the first period to be the short help, independent how many lines it spans. Consider the following: ``` import click @click.group() def grp(): pass @grp.command() def cmd1(): """First sentence. Second sentence.""" @grp.command() def cmd2(): """Summary line without a period First real sentence. Another sentence. """ ``` ``` $ python3 foo.py --help Usage: foo.py [OPTIONS] COMMAND [ARGS]... Options: --help Show this message and exit. Commands: cmd1 First sentence. cmd2 Summary line without a period First real... ``` To me it would feel more natural: 1. to take the first line as short help, independent of punctuation OR 1. to look for an ending of a phrase or linebreak, whichever comes first. Both would allow for summary lines without the requirement to end in a period. While this would violate PEP257, I would consider it a gray area, as that summary line is used as short help in a list of commands and I have a use case where a company style guide requires such lists not to end in periods. I'd be happy to provide a pull request for either solution, if it would be accepted.	[ { "content": "import os\nimport sys\n\nfrom ._compat import _default_text_stderr\nfrom ._compat import _default_text_stdout\nfrom ._compat import _find_binary_writer\nfrom ._compat import auto_wrap_for_ansi\nfrom ._compat import binary_streams\nfrom ._compat import filename_to_ui\nfrom ._compat import get_filesystem_encoding\nfrom ._compat import get_strerror\nfrom ._compat import is_bytes\nfrom ._compat import open_stream\nfrom ._compat import should_strip_ansi\nfrom ._compat import strip_ansi\nfrom ._compat import text_streams\nfrom ._compat import WIN\nfrom .globals import resolve_color_default\n\n\necho_native_types = (str, bytes, bytearray)\n\n\ndef _posixify(name):\n return \"-\".join(name.split()).lower()\n\n\ndef safecall(func):\n \"\"\"Wraps a function so that it swallows exceptions.\"\"\"\n\n def wrapper(args, kwargs):\n try:\n return func(args, **kwargs)\n except Exception:\n pass\n\n return wrapper\n\n\ndef make_str(value):\n \"\"\"Converts a value into a valid string.\"\"\"\n if isinstance(value, bytes):\n try:\n return value.decode(get_filesystem_encoding())\n except UnicodeError:\n return value.decode(\"utf-8\", \"replace\")\n return str(value)\n\n\ndef make_default_short_help(help, max_length=45):\n \"\"\"Return a condensed version of help string.\"\"\"\n words = help.split()\n total_length = 0\n result = []\n done = False\n\n for word in words:\n if word[-1:] == \".\":\n done = True\n new_length = 1 + len(word) if result else len(word)\n if total_length + new_length > max_length:\n result.append(\"...\")\n done = True\n else:\n if result:\n result.append(\" \")\n result.append(word)\n if done:\n break\n total_length += new_length\n\n return \"\".join(result)\n\n\nclass LazyFile:\n \"\"\"A lazy file works like a regular file but it does not fully open\n the file but it does perform some basic checks early to see if the\n filename parameter does make sense. This is useful for safely opening\n files for writing.\n \"\"\"\n\n def __init__(\n self, filename, mode=\"r\", encoding=None, errors=\"strict\", atomic=False\n ):\n self.name = filename\n self.mode = mode\n self.encoding = encoding\n self.errors = errors\n self.atomic = atomic\n\n if filename == \"-\":\n self._f, self.should_close = open_stream(filename, mode, encoding, errors)\n else:\n if \"r\" in mode:\n # Open and close the file in case we're opening it for\n # reading so that we can catch at least some errors in\n # some cases early.\n open(filename, mode).close()\n self._f = None\n self.should_close = True\n\n def __getattr__(self, name):\n return getattr(self.open(), name)\n\n def __repr__(self):\n if self._f is not None:\n return repr(self._f)\n return f\"<unopened file '{self.name}' {self.mode}>\"\n\n def open(self):\n \"\"\"Opens the file if it's not yet open. This call might fail with\n a :exc:`FileError`. Not handling this error will produce an error\n that Click shows.\n \"\"\"\n if self._f is not None:\n return self._f\n try:\n rv, self.should_close = open_stream(\n self.name, self.mode, self.encoding, self.errors, atomic=self.atomic\n )\n except OSError as e: # noqa: E402\n from .exceptions import FileError\n\n raise FileError(self.name, hint=get_strerror(e))\n self._f = rv\n return rv\n\n def close(self):\n \"\"\"Closes the underlying file, no matter what.\"\"\"\n if self._f is not None:\n self._f.close()\n\n def close_intelligently(self):\n \"\"\"This function only closes the file if it was opened by the lazy\n file wrapper. For instance this will never close stdin.\n \"\"\"\n if self.should_close:\n self.close()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, tb):\n self.close_intelligently()\n\n def __iter__(self):\n self.open()\n return iter(self._f)\n\n\nclass KeepOpenFile:\n def __init__(self, file):\n self._file = file\n\n def __getattr__(self, name):\n return getattr(self._file, name)\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, tb):\n pass\n\n def __repr__(self):\n return repr(self._file)\n\n def __iter__(self):\n return iter(self._file)\n\n\ndef echo(message=None, file=None, nl=True, err=False, color=None):\n \"\"\"Prints a message plus a newline to the given file or stdout. On\n first sight, this looks like the print function, but it has improved\n support for handling Unicode and binary data that does not fail no\n matter how badly configured the system is.\n\n Primarily it means that you can print binary data as well as Unicode\n data on both 2.x and 3.x to the given file in the most appropriate way\n possible. This is a very carefree function in that it will try its\n best to not fail. As of Click 6.0 this includes support for unicode\n output on the Windows console.\n\n In addition to that, if `colorama`_ is installed, the echo function will\n also support clever handling of ANSI codes. Essentially it will then\n do the following:\n\n - add transparent handling of ANSI color codes on Windows.\n - hide ANSI codes automatically if the destination file is not a\n terminal.\n\n .. _colorama: https://pypi.org/project/colorama/\n\n .. versionchanged:: 6.0\n As of Click 6.0 the echo function will properly support unicode\n output on the windows console. Not that click does not modify\n the interpreter in any way which means that `sys.stdout` or the\n print statement or function will still not provide unicode support.\n\n .. versionchanged:: 2.0\n Starting with version 2.0 of Click, the echo function will work\n with colorama if it's installed.\n\n .. versionadded:: 3.0\n The `err` parameter was added.\n\n .. versionchanged:: 4.0\n Added the `color` flag.\n\n :param message: the message to print\n :param file: the file to write to (defaults to ``stdout``)\n :param err: if set to true the file defaults to ``stderr`` instead of\n ``stdout``. This is faster and easier than calling\n :func:`get_text_stderr` yourself.\n :param nl: if set to `True` (the default) a newline is printed afterwards.\n :param color: controls if the terminal supports ANSI colors or not. The\n default is autodetection.\n \"\"\"\n if file is None:\n if err:\n file = _default_text_stderr()\n else:\n file = _default_text_stdout()\n\n # Convert non bytes/text into the native string type.\n if message is not None and not isinstance(message, echo_native_types):\n message = str(message)\n\n if nl:\n message = message or \"\"\n if isinstance(message, str):\n message += \"\\n\"\n else:\n message += b\"\\n\"\n\n # If there is a message and the value looks like bytes, we manually\n # need to find the binary stream and write the message in there.\n # This is done separately so that most stream types will work as you\n # would expect. Eg: you can write to StringIO for other cases.\n if message and is_bytes(message):\n binary_file = _find_binary_writer(file)\n if binary_file is not None:\n file.flush()\n binary_file.write(message)\n binary_file.flush()\n return\n\n # ANSI-style support. If there is no message or we are dealing with\n # bytes nothing is happening. If we are connected to a file we want\n # to strip colors. If we are on windows we either wrap the stream\n # to strip the color or we use the colorama support to translate the\n # ansi codes to API calls.\n if message and not is_bytes(message):\n color = resolve_color_default(color)\n if should_strip_ansi(file, color):\n message = strip_ansi(message)\n elif WIN:\n if auto_wrap_for_ansi is not None:\n file = auto_wrap_for_ansi(file)\n elif not color:\n message = strip_ansi(message)\n\n if message:\n file.write(message)\n file.flush()\n\n\ndef get_binary_stream(name):\n \"\"\"Returns a system stream for byte processing.\n\n :param name: the name of the stream to open. Valid names are ``'stdin'``,\n ``'stdout'`` and ``'stderr'``\n \"\"\"\n opener = binary_streams.get(name)\n if opener is None:\n raise TypeError(f\"Unknown standard stream '{name}'\")\n return opener()\n\n\ndef get_text_stream(name, encoding=None, errors=\"strict\"):\n \"\"\"Returns a system stream for text processing. This usually returns\n a wrapped stream around a binary stream returned from\n :func:`get_binary_stream` but it also can take shortcuts for already\n correctly configured streams.\n\n :param name: the name of the stream to open. Valid names are ``'stdin'``,\n ``'stdout'`` and ``'stderr'``\n :param encoding: overrides the detected default encoding.\n :param errors: overrides the default error mode.\n \"\"\"\n opener = text_streams.get(name)\n if opener is None:\n raise TypeError(f\"Unknown standard stream '{name}'\")\n return opener(encoding, errors)\n\n\ndef open_file(\n filename, mode=\"r\", encoding=None, errors=\"strict\", lazy=False, atomic=False\n):\n \"\"\"This is similar to how the :class:`File` works but for manual\n usage. Files are opened non lazy by default. This can open regular\n files as well as stdin/stdout if ``'-'`` is passed.\n\n If stdin/stdout is returned the stream is wrapped so that the context\n manager will not close the stream accidentally. This makes it possible\n to always use the function like this without having to worry to\n accidentally close a standard stream::\n\n with open_file(filename) as f:\n ...\n\n .. versionadded:: 3.0\n\n :param filename: the name of the file to open (or ``'-'`` for stdin/stdout).\n :param mode: the mode in which to open the file.\n :param encoding: the encoding to use.\n :param errors: the error handling for this file.\n :param lazy: can be flipped to true to open the file lazily.\n :param atomic: in atomic mode writes go into a temporary file and it's\n moved on close.\n \"\"\"\n if lazy:\n return LazyFile(filename, mode, encoding, errors, atomic=atomic)\n f, should_close = open_stream(filename, mode, encoding, errors, atomic=atomic)\n if not should_close:\n f = KeepOpenFile(f)\n return f\n\n\ndef get_os_args():\n \"\"\"Returns the argument part of ``sys.argv``, removing the first\n value which is the name of the script.\n\n .. deprecated:: 8.0\n Will be removed in 8.1. Access ``sys.argv[1:]`` directly\n instead.\n \"\"\"\n import warnings\n\n warnings.warn(\n \"'get_os_args' is deprecated and will be removed in 8.1. Access\"\n \" 'sys.argv[1:]' directly instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return sys.argv[1:]\n\n\ndef format_filename(filename, shorten=False):\n \"\"\"Formats a filename for user display. The main purpose of this\n function is to ensure that the filename can be displayed at all. This\n will decode the filename to unicode if necessary in a way that it will\n not fail. Optionally, it can shorten the filename to not include the\n full path to the filename.\n\n :param filename: formats a filename for UI display. This will also convert\n the filename into unicode without failing.\n :param shorten: this optionally shortens the filename to strip of the\n path that leads up to it.\n \"\"\"\n if shorten:\n filename = os.path.basename(filename)\n return filename_to_ui(filename)\n\n\ndef get_app_dir(app_name, roaming=True, force_posix=False):\n r\"\"\"Returns the config folder for the application. The default behavior\n is to return whatever is most appropriate for the operating system.\n\n To give you an idea, for an app called ``\"Foo Bar\"``, something like\n the following folders could be returned:\n\n Mac OS X:\n ``~/Library/Application Support/Foo Bar``\n Mac OS X (POSIX):\n ``~/.foo-bar``\n Unix:\n ``~/.config/foo-bar``\n Unix (POSIX):\n ``~/.foo-bar``\n Win XP (roaming):\n ``C:\\Documents and Settings\\<user>\\Local Settings\\Application Data\\Foo Bar``\n Win XP (not roaming):\n ``C:\\Documents and Settings\\<user>\\Application Data\\Foo Bar``\n Win 7 (roaming):\n ``C:\\Users\\<user>\\AppData\\Roaming\\Foo Bar``\n Win 7 (not roaming):\n ``C:\\Users\\<user>\\AppData\\Local\\Foo Bar``\n\n .. versionadded:: 2.0\n\n :param app_name: the application name. This should be properly capitalized\n and can contain whitespace.\n :param roaming: controls if the folder should be roaming or not on Windows.\n Has no affect otherwise.\n :param force_posix: if this is set to `True` then on any POSIX system the\n folder will be stored in the home folder with a leading\n dot instead of the XDG config home or darwin's\n application support folder.\n \"\"\"\n if WIN:\n key = \"APPDATA\" if roaming else \"LOCALAPPDATA\"\n folder = os.environ.get(key)\n if folder is None:\n folder = os.path.expanduser(\"~\")\n return os.path.join(folder, app_name)\n if force_posix:\n return os.path.join(os.path.expanduser(f\"~/.{_posixify(app_name)}\"))\n if sys.platform == \"darwin\":\n return os.path.join(\n os.path.expanduser(\"~/Library/Application Support\"), app_name\n )\n return os.path.join(\n os.environ.get(\"XDG_CONFIG_HOME\", os.path.expanduser(\"~/.config\")),\n _posixify(app_name),\n )\n\n\nclass PacifyFlushWrapper:\n \"\"\"This wrapper is used to catch and suppress BrokenPipeErrors resulting\n from ``.flush()`` being called on broken pipe during the shutdown/final-GC\n of the Python interpreter. Notably ``.flush()`` is always called on\n ``sys.stdout`` and ``sys.stderr``. So as to have minimal impact on any\n other cleanup code, and the case where the underlying file is not a broken\n pipe, all calls and attributes are proxied.\n \"\"\"\n\n def __init__(self, wrapped):\n self.wrapped = wrapped\n\n def flush(self):\n try:\n self.wrapped.flush()\n except OSError as e:\n import errno\n\n if e.errno != errno.EPIPE:\n raise\n\n def __getattr__(self, attr):\n return getattr(self.wrapped, attr)\n\n\ndef _detect_program_name(path=None, _main=sys.modules[\"__main__\"]):\n \"\"\"Determine the command used to run the program, for use in help\n text. If a file or entry point was executed, the file name is\n returned. If ``python -m`` was used to execute a module or package,\n ``python -m name`` is returned.\n\n This doesn't try to be too precise, the goal is to give a concise\n name for help text. Files are only shown as their name without the\n path. ``python`` is only shown for modules, and the full path to\n ``sys.executable`` is not shown.\n\n :param path: The Python file being executed. Python puts this in\n ``sys.argv[0]``, which is used by default.\n :param _main: The ``__main__`` module. This should only be passed\n during internal testing.\n\n .. versionadded:: 8.0\n Based on command args detection in the Werkzeug reloader.\n\n :meta private:\n \"\"\"\n if not path:\n path = sys.argv[0]\n\n # The value of __package__ indicates how Python was called. It may\n # not exist if a setuptools script is installed as an egg. It may be\n # set incorrectly for entry points created with pip on Windows.\n if getattr(_main, \"__package__\", None) is None or (\n os.name == \"nt\"\n and _main.__package__ == \"\"\n and not os.path.exists(path)\n and os.path.exists(f\"{path}.exe\")\n ):\n # Executed a file, like \"python app.py\".\n return os.path.basename(path)\n\n # Executed a module, like \"python -m example\".\n # Rewritten by Python from \"-m script\" to \"/path/to/script.py\".\n # Need to look at main module to determine how it was executed.\n py_module = _main.__package__\n name = os.path.splitext(os.path.basename(path))[0]\n\n # A submodule like \"example.cli\".\n if name != \"__main__\":\n py_module = f\"{py_module}.{name}\"\n\n return f\"python -m {py_module.lstrip('.')}\"\n", "path": "src/click/utils.py" } ]	[ { "content": "import os\nimport sys\n\nfrom ._compat import _default_text_stderr\nfrom ._compat import _default_text_stdout\nfrom ._compat import _find_binary_writer\nfrom ._compat import auto_wrap_for_ansi\nfrom ._compat import binary_streams\nfrom ._compat import filename_to_ui\nfrom ._compat import get_filesystem_encoding\nfrom ._compat import get_strerror\nfrom ._compat import is_bytes\nfrom ._compat import open_stream\nfrom ._compat import should_strip_ansi\nfrom ._compat import strip_ansi\nfrom ._compat import text_streams\nfrom ._compat import WIN\nfrom .globals import resolve_color_default\n\n\necho_native_types = (str, bytes, bytearray)\n\n\ndef _posixify(name):\n return \"-\".join(name.split()).lower()\n\n\ndef safecall(func):\n \"\"\"Wraps a function so that it swallows exceptions.\"\"\"\n\n def wrapper(args, kwargs):\n try:\n return func(args, **kwargs)\n except Exception:\n pass\n\n return wrapper\n\n\ndef make_str(value):\n \"\"\"Converts a value into a valid string.\"\"\"\n if isinstance(value, bytes):\n try:\n return value.decode(get_filesystem_encoding())\n except UnicodeError:\n return value.decode(\"utf-8\", \"replace\")\n return str(value)\n\n\ndef make_default_short_help(help, max_length=45):\n \"\"\"Return a condensed version of help string.\"\"\"\n line_ending = help.find(\"\\n\\n\")\n if line_ending != -1:\n help = help[:line_ending]\n words = help.split()\n total_length = 0\n result = []\n done = False\n\n for word in words:\n if word[-1:] == \".\":\n done = True\n new_length = 1 + len(word) if result else len(word)\n if total_length + new_length > max_length:\n result.append(\"...\")\n done = True\n else:\n if result:\n result.append(\" \")\n result.append(word)\n if done:\n break\n total_length += new_length\n\n return \"\".join(result)\n\n\nclass LazyFile:\n \"\"\"A lazy file works like a regular file but it does not fully open\n the file but it does perform some basic checks early to see if the\n filename parameter does make sense. This is useful for safely opening\n files for writing.\n \"\"\"\n\n def __init__(\n self, filename, mode=\"r\", encoding=None, errors=\"strict\", atomic=False\n ):\n self.name = filename\n self.mode = mode\n self.encoding = encoding\n self.errors = errors\n self.atomic = atomic\n\n if filename == \"-\":\n self._f, self.should_close = open_stream(filename, mode, encoding, errors)\n else:\n if \"r\" in mode:\n # Open and close the file in case we're opening it for\n # reading so that we can catch at least some errors in\n # some cases early.\n open(filename, mode).close()\n self._f = None\n self.should_close = True\n\n def __getattr__(self, name):\n return getattr(self.open(), name)\n\n def __repr__(self):\n if self._f is not None:\n return repr(self._f)\n return f\"<unopened file '{self.name}' {self.mode}>\"\n\n def open(self):\n \"\"\"Opens the file if it's not yet open. This call might fail with\n a :exc:`FileError`. Not handling this error will produce an error\n that Click shows.\n \"\"\"\n if self._f is not None:\n return self._f\n try:\n rv, self.should_close = open_stream(\n self.name, self.mode, self.encoding, self.errors, atomic=self.atomic\n )\n except OSError as e: # noqa: E402\n from .exceptions import FileError\n\n raise FileError(self.name, hint=get_strerror(e))\n self._f = rv\n return rv\n\n def close(self):\n \"\"\"Closes the underlying file, no matter what.\"\"\"\n if self._f is not None:\n self._f.close()\n\n def close_intelligently(self):\n \"\"\"This function only closes the file if it was opened by the lazy\n file wrapper. For instance this will never close stdin.\n \"\"\"\n if self.should_close:\n self.close()\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, tb):\n self.close_intelligently()\n\n def __iter__(self):\n self.open()\n return iter(self._f)\n\n\nclass KeepOpenFile:\n def __init__(self, file):\n self._file = file\n\n def __getattr__(self, name):\n return getattr(self._file, name)\n\n def __enter__(self):\n return self\n\n def __exit__(self, exc_type, exc_value, tb):\n pass\n\n def __repr__(self):\n return repr(self._file)\n\n def __iter__(self):\n return iter(self._file)\n\n\ndef echo(message=None, file=None, nl=True, err=False, color=None):\n \"\"\"Prints a message plus a newline to the given file or stdout. On\n first sight, this looks like the print function, but it has improved\n support for handling Unicode and binary data that does not fail no\n matter how badly configured the system is.\n\n Primarily it means that you can print binary data as well as Unicode\n data on both 2.x and 3.x to the given file in the most appropriate way\n possible. This is a very carefree function in that it will try its\n best to not fail. As of Click 6.0 this includes support for unicode\n output on the Windows console.\n\n In addition to that, if `colorama`_ is installed, the echo function will\n also support clever handling of ANSI codes. Essentially it will then\n do the following:\n\n - add transparent handling of ANSI color codes on Windows.\n - hide ANSI codes automatically if the destination file is not a\n terminal.\n\n .. _colorama: https://pypi.org/project/colorama/\n\n .. versionchanged:: 6.0\n As of Click 6.0 the echo function will properly support unicode\n output on the windows console. Not that click does not modify\n the interpreter in any way which means that `sys.stdout` or the\n print statement or function will still not provide unicode support.\n\n .. versionchanged:: 2.0\n Starting with version 2.0 of Click, the echo function will work\n with colorama if it's installed.\n\n .. versionadded:: 3.0\n The `err` parameter was added.\n\n .. versionchanged:: 4.0\n Added the `color` flag.\n\n :param message: the message to print\n :param file: the file to write to (defaults to ``stdout``)\n :param err: if set to true the file defaults to ``stderr`` instead of\n ``stdout``. This is faster and easier than calling\n :func:`get_text_stderr` yourself.\n :param nl: if set to `True` (the default) a newline is printed afterwards.\n :param color: controls if the terminal supports ANSI colors or not. The\n default is autodetection.\n \"\"\"\n if file is None:\n if err:\n file = _default_text_stderr()\n else:\n file = _default_text_stdout()\n\n # Convert non bytes/text into the native string type.\n if message is not None and not isinstance(message, echo_native_types):\n message = str(message)\n\n if nl:\n message = message or \"\"\n if isinstance(message, str):\n message += \"\\n\"\n else:\n message += b\"\\n\"\n\n # If there is a message and the value looks like bytes, we manually\n # need to find the binary stream and write the message in there.\n # This is done separately so that most stream types will work as you\n # would expect. Eg: you can write to StringIO for other cases.\n if message and is_bytes(message):\n binary_file = _find_binary_writer(file)\n if binary_file is not None:\n file.flush()\n binary_file.write(message)\n binary_file.flush()\n return\n\n # ANSI-style support. If there is no message or we are dealing with\n # bytes nothing is happening. If we are connected to a file we want\n # to strip colors. If we are on windows we either wrap the stream\n # to strip the color or we use the colorama support to translate the\n # ansi codes to API calls.\n if message and not is_bytes(message):\n color = resolve_color_default(color)\n if should_strip_ansi(file, color):\n message = strip_ansi(message)\n elif WIN:\n if auto_wrap_for_ansi is not None:\n file = auto_wrap_for_ansi(file)\n elif not color:\n message = strip_ansi(message)\n\n if message:\n file.write(message)\n file.flush()\n\n\ndef get_binary_stream(name):\n \"\"\"Returns a system stream for byte processing.\n\n :param name: the name of the stream to open. Valid names are ``'stdin'``,\n ``'stdout'`` and ``'stderr'``\n \"\"\"\n opener = binary_streams.get(name)\n if opener is None:\n raise TypeError(f\"Unknown standard stream '{name}'\")\n return opener()\n\n\ndef get_text_stream(name, encoding=None, errors=\"strict\"):\n \"\"\"Returns a system stream for text processing. This usually returns\n a wrapped stream around a binary stream returned from\n :func:`get_binary_stream` but it also can take shortcuts for already\n correctly configured streams.\n\n :param name: the name of the stream to open. Valid names are ``'stdin'``,\n ``'stdout'`` and ``'stderr'``\n :param encoding: overrides the detected default encoding.\n :param errors: overrides the default error mode.\n \"\"\"\n opener = text_streams.get(name)\n if opener is None:\n raise TypeError(f\"Unknown standard stream '{name}'\")\n return opener(encoding, errors)\n\n\ndef open_file(\n filename, mode=\"r\", encoding=None, errors=\"strict\", lazy=False, atomic=False\n):\n \"\"\"This is similar to how the :class:`File` works but for manual\n usage. Files are opened non lazy by default. This can open regular\n files as well as stdin/stdout if ``'-'`` is passed.\n\n If stdin/stdout is returned the stream is wrapped so that the context\n manager will not close the stream accidentally. This makes it possible\n to always use the function like this without having to worry to\n accidentally close a standard stream::\n\n with open_file(filename) as f:\n ...\n\n .. versionadded:: 3.0\n\n :param filename: the name of the file to open (or ``'-'`` for stdin/stdout).\n :param mode: the mode in which to open the file.\n :param encoding: the encoding to use.\n :param errors: the error handling for this file.\n :param lazy: can be flipped to true to open the file lazily.\n :param atomic: in atomic mode writes go into a temporary file and it's\n moved on close.\n \"\"\"\n if lazy:\n return LazyFile(filename, mode, encoding, errors, atomic=atomic)\n f, should_close = open_stream(filename, mode, encoding, errors, atomic=atomic)\n if not should_close:\n f = KeepOpenFile(f)\n return f\n\n\ndef get_os_args():\n \"\"\"Returns the argument part of ``sys.argv``, removing the first\n value which is the name of the script.\n\n .. deprecated:: 8.0\n Will be removed in 8.1. Access ``sys.argv[1:]`` directly\n instead.\n \"\"\"\n import warnings\n\n warnings.warn(\n \"'get_os_args' is deprecated and will be removed in 8.1. Access\"\n \" 'sys.argv[1:]' directly instead.\",\n DeprecationWarning,\n stacklevel=2,\n )\n return sys.argv[1:]\n\n\ndef format_filename(filename, shorten=False):\n \"\"\"Formats a filename for user display. The main purpose of this\n function is to ensure that the filename can be displayed at all. This\n will decode the filename to unicode if necessary in a way that it will\n not fail. Optionally, it can shorten the filename to not include the\n full path to the filename.\n\n :param filename: formats a filename for UI display. This will also convert\n the filename into unicode without failing.\n :param shorten: this optionally shortens the filename to strip of the\n path that leads up to it.\n \"\"\"\n if shorten:\n filename = os.path.basename(filename)\n return filename_to_ui(filename)\n\n\ndef get_app_dir(app_name, roaming=True, force_posix=False):\n r\"\"\"Returns the config folder for the application. The default behavior\n is to return whatever is most appropriate for the operating system.\n\n To give you an idea, for an app called ``\"Foo Bar\"``, something like\n the following folders could be returned:\n\n Mac OS X:\n ``~/Library/Application Support/Foo Bar``\n Mac OS X (POSIX):\n ``~/.foo-bar``\n Unix:\n ``~/.config/foo-bar``\n Unix (POSIX):\n ``~/.foo-bar``\n Win XP (roaming):\n ``C:\\Documents and Settings\\<user>\\Local Settings\\Application Data\\Foo Bar``\n Win XP (not roaming):\n ``C:\\Documents and Settings\\<user>\\Application Data\\Foo Bar``\n Win 7 (roaming):\n ``C:\\Users\\<user>\\AppData\\Roaming\\Foo Bar``\n Win 7 (not roaming):\n ``C:\\Users\\<user>\\AppData\\Local\\Foo Bar``\n\n .. versionadded:: 2.0\n\n :param app_name: the application name. This should be properly capitalized\n and can contain whitespace.\n :param roaming: controls if the folder should be roaming or not on Windows.\n Has no affect otherwise.\n :param force_posix: if this is set to `True` then on any POSIX system the\n folder will be stored in the home folder with a leading\n dot instead of the XDG config home or darwin's\n application support folder.\n \"\"\"\n if WIN:\n key = \"APPDATA\" if roaming else \"LOCALAPPDATA\"\n folder = os.environ.get(key)\n if folder is None:\n folder = os.path.expanduser(\"~\")\n return os.path.join(folder, app_name)\n if force_posix:\n return os.path.join(os.path.expanduser(f\"~/.{_posixify(app_name)}\"))\n if sys.platform == \"darwin\":\n return os.path.join(\n os.path.expanduser(\"~/Library/Application Support\"), app_name\n )\n return os.path.join(\n os.environ.get(\"XDG_CONFIG_HOME\", os.path.expanduser(\"~/.config\")),\n _posixify(app_name),\n )\n\n\nclass PacifyFlushWrapper:\n \"\"\"This wrapper is used to catch and suppress BrokenPipeErrors resulting\n from ``.flush()`` being called on broken pipe during the shutdown/final-GC\n of the Python interpreter. Notably ``.flush()`` is always called on\n ``sys.stdout`` and ``sys.stderr``. So as to have minimal impact on any\n other cleanup code, and the case where the underlying file is not a broken\n pipe, all calls and attributes are proxied.\n \"\"\"\n\n def __init__(self, wrapped):\n self.wrapped = wrapped\n\n def flush(self):\n try:\n self.wrapped.flush()\n except OSError as e:\n import errno\n\n if e.errno != errno.EPIPE:\n raise\n\n def __getattr__(self, attr):\n return getattr(self.wrapped, attr)\n\n\ndef _detect_program_name(path=None, _main=sys.modules[\"__main__\"]):\n \"\"\"Determine the command used to run the program, for use in help\n text. If a file or entry point was executed, the file name is\n returned. If ``python -m`` was used to execute a module or package,\n ``python -m name`` is returned.\n\n This doesn't try to be too precise, the goal is to give a concise\n name for help text. Files are only shown as their name without the\n path. ``python`` is only shown for modules, and the full path to\n ``sys.executable`` is not shown.\n\n :param path: The Python file being executed. Python puts this in\n ``sys.argv[0]``, which is used by default.\n :param _main: The ``__main__`` module. This should only be passed\n during internal testing.\n\n .. versionadded:: 8.0\n Based on command args detection in the Werkzeug reloader.\n\n :meta private:\n \"\"\"\n if not path:\n path = sys.argv[0]\n\n # The value of __package__ indicates how Python was called. It may\n # not exist if a setuptools script is installed as an egg. It may be\n # set incorrectly for entry points created with pip on Windows.\n if getattr(_main, \"__package__\", None) is None or (\n os.name == \"nt\"\n and _main.__package__ == \"\"\n and not os.path.exists(path)\n and os.path.exists(f\"{path}.exe\")\n ):\n # Executed a file, like \"python app.py\".\n return os.path.basename(path)\n\n # Executed a module, like \"python -m example\".\n # Rewritten by Python from \"-m script\" to \"/path/to/script.py\".\n # Need to look at main module to determine how it was executed.\n py_module = _main.__package__\n name = os.path.splitext(os.path.basename(path))[0]\n\n # A submodule like \"example.cli\".\n if name != \"__main__\":\n py_module = f\"{py_module}.{name}\"\n\n return f\"python -m {py_module.lstrip('.')}\"\n", "path": "src/click/utils.py" } ]	diff --git a/CHANGES.rst b/CHANGES.rst index c11d9108d..d86e7cede 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -147,6 +147,8 @@ Unreleased - Fix formatting when ``Command.options_metavar`` is empty. :pr:`1551` - The default value passed to ``prompt`` will be cast to the correct type like an input value would be. :pr:`1517` +- Automatically generated short help messages will stop at the first + ending of a phrase or double linebreak. :issue:`1082` Version 7.1.2 diff --git a/src/click/utils.py b/src/click/utils.py index 0bff5c0ff..dfb84ce33 100644 --- a/src/click/utils.py +++ b/src/click/utils.py @@ -49,6 +49,9 @@ def make_str(value): def make_default_short_help(help, max_length=45): """Return a condensed version of help string.""" + line_ending = help.find("\n\n") + if line_ending != -1: + help = help[:line_ending] words = help.split() total_length = 0 result = [] diff --git a/tests/test_basic.py b/tests/test_basic.py index de9b0acea..47356277b 100644 --- a/tests/test_basic.py +++ b/tests/test_basic.py @@ -528,3 +528,22 @@ def nope(): assert result.exit_code == 0 assert "subgroup" not in result.output assert "nope" not in result.output + + +def test_summary_line(runner): + @click.group() + def cli(): + pass + + @cli.command() + def cmd(): + """ + Summary line without period + + Here is a sentence. And here too. + """ + pass + + result = runner.invoke(cli, ["--help"]) + assert "Summary line without period" in result.output + assert "Here is a sentence." not in result.output
netbox-community__netbox-12228	L2VPN Bulk import not setting Tenant field ### NetBox version v3.4.7 ### Python version 3.8 ### Steps to Reproduce 1. Go to Overlay -> L2VPNs 2. Click the 'Import' button 3. Fill the Data Import text field with data that has `tenant` column populated 4. Submit the form ### Expected Behavior Imported L2VPNs should have Tenant specified in `tenant` field linked to it. ### Observed Behavior Imported L2VPNs do not belong to any Tenant, as if the `tenant` field was not specified.	[ { "content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext as _\n\nfrom dcim.models import Device, Interface, Site\nfrom ipam.choices import \nfrom ipam.constants import \nfrom ipam.models import \nfrom netbox.forms import NetBoxModelImportForm\nfrom tenancy.models import Tenant\nfrom utilities.forms import CSVChoiceField, CSVContentTypeField, CSVModelChoiceField, SlugField\nfrom virtualization.models import VirtualMachine, VMInterface\n\n__all__ = (\n 'AggregateImportForm',\n 'ASNImportForm',\n 'FHRPGroupImportForm',\n 'IPAddressImportForm',\n 'IPRangeImportForm',\n 'L2VPNImportForm',\n 'L2VPNTerminationImportForm',\n 'PrefixImportForm',\n 'RIRImportForm',\n 'RoleImportForm',\n 'RouteTargetImportForm',\n 'ServiceImportForm',\n 'ServiceTemplateImportForm',\n 'VLANImportForm',\n 'VLANGroupImportForm',\n 'VRFImportForm',\n)\n\n\nclass VRFImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = VRF\n fields = ('name', 'rd', 'tenant', 'enforce_unique', 'description', 'comments', 'tags')\n\n\nclass RouteTargetImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = RouteTarget\n fields = ('name', 'tenant', 'description', 'comments', 'tags')\n\n\nclass RIRImportForm(NetBoxModelImportForm):\n slug = SlugField()\n\n class Meta:\n model = RIR\n fields = ('name', 'slug', 'is_private', 'description', 'tags')\n help_texts = {\n 'name': _('RIR name'),\n }\n\n\nclass AggregateImportForm(NetBoxModelImportForm):\n rir = CSVModelChoiceField(\n queryset=RIR.objects.all(),\n to_field_name='name',\n help_text=_('Assigned RIR')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = Aggregate\n fields = ('prefix', 'rir', 'tenant', 'date_added', 'description', 'comments', 'tags')\n\n\nclass ASNImportForm(NetBoxModelImportForm):\n rir = CSVModelChoiceField(\n queryset=RIR.objects.all(),\n to_field_name='name',\n help_text=_('Assigned RIR')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = ASN\n fields = ('asn', 'rir', 'tenant', 'description', 'comments', 'tags')\n\n\nclass RoleImportForm(NetBoxModelImportForm):\n slug = SlugField()\n\n class Meta:\n model = Role\n fields = ('name', 'slug', 'weight', 'description', 'tags')\n\n\nclass PrefixImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n site = CSVModelChoiceField(\n queryset=Site.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned site')\n )\n vlan_group = CSVModelChoiceField(\n queryset=VLANGroup.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_(\"VLAN's group (if any)\")\n )\n vlan = CSVModelChoiceField(\n queryset=VLAN.objects.all(),\n required=False,\n to_field_name='vid',\n help_text=_(\"Assigned VLAN\")\n )\n status = CSVChoiceField(\n choices=PrefixStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = Prefix\n fields = (\n 'prefix', 'vrf', 'tenant', 'site', 'vlan_group', 'vlan', 'status', 'role', 'is_pool', 'mark_utilized',\n 'description', 'comments', 'tags',\n )\n\n def __init__(self, data=None, args, *kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit VLAN queryset by assigned site and/or group (if specified)\n params = {}\n if data.get('site'):\n params[f\"site__{self.fields['site'].to_field_name}\"] = data.get('site')\n if data.get('vlan_group'):\n params[f\"group__{self.fields['vlan_group'].to_field_name}\"] = data.get('vlan_group')\n if params:\n self.fields['vlan'].queryset = self.fields['vlan'].queryset.filter(params)\n\n\nclass IPRangeImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=IPRangeStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = IPRange\n fields = (\n 'start_address', 'end_address', 'vrf', 'tenant', 'status', 'role', 'description', 'comments', 'tags',\n )\n\n\nclass IPAddressImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=IPAddressStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVChoiceField(\n choices=IPAddressRoleChoices,\n required=False,\n help_text=_('Functional role')\n )\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent device of assigned interface (if any)')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent VM of assigned interface (if any)')\n )\n interface = CSVModelChoiceField(\n queryset=Interface.objects.none(), # Can also refer to VMInterface\n required=False,\n to_field_name='name',\n help_text=_('Assigned interface')\n )\n is_primary = forms.BooleanField(\n help_text=_('Make this the primary IP for the assigned device'),\n required=False\n )\n\n class Meta:\n model = IPAddress\n fields = [\n 'address', 'vrf', 'tenant', 'status', 'role', 'device', 'virtual_machine', 'interface', 'is_primary',\n 'dns_name', 'description', 'comments', 'tags',\n ]\n\n def __init__(self, data=None, args, kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit interface queryset by assigned device\n if data.get('device'):\n self.fields['interface'].queryset = Interface.objects.filter(\n {f\"device__{self.fields['device'].to_field_name}\": data['device']}\n )\n\n # Limit interface queryset by assigned device\n elif data.get('virtual_machine'):\n self.fields['interface'].queryset = VMInterface.objects.filter(\n *{f\"virtual_machine__{self.fields['virtual_machine'].to_field_name}\": data['virtual_machine']}\n )\n\n def clean(self):\n super().clean()\n\n device = self.cleaned_data.get('device')\n virtual_machine = self.cleaned_data.get('virtual_machine')\n interface = self.cleaned_data.get('interface')\n is_primary = self.cleaned_data.get('is_primary')\n\n # Validate is_primary\n if is_primary and not device and not virtual_machine:\n raise forms.ValidationError({\n \"is_primary\": \"No device or virtual machine specified; cannot set as primary IP\"\n })\n if is_primary and not interface:\n raise forms.ValidationError({\n \"is_primary\": \"No interface specified; cannot set as primary IP\"\n })\n\n def save(self, args, *kwargs):\n\n # Set interface assignment\n if self.cleaned_data.get('interface'):\n self.instance.assigned_object = self.cleaned_data['interface']\n\n ipaddress = super().save(args, *kwargs)\n\n # Set as primary for device/VM\n if self.cleaned_data.get('is_primary'):\n parent = self.cleaned_data['device'] or self.cleaned_data['virtual_machine']\n if self.instance.address.version == 4:\n parent.primary_ip4 = ipaddress\n elif self.instance.address.version == 6:\n parent.primary_ip6 = ipaddress\n parent.save()\n\n return ipaddress\n\n\nclass FHRPGroupImportForm(NetBoxModelImportForm):\n protocol = CSVChoiceField(\n choices=FHRPGroupProtocolChoices\n )\n auth_type = CSVChoiceField(\n choices=FHRPGroupAuthTypeChoices,\n required=False\n )\n\n class Meta:\n model = FHRPGroup\n fields = ('protocol', 'group_id', 'auth_type', 'auth_key', 'name', 'description', 'comments', 'tags')\n\n\nclass VLANGroupImportForm(NetBoxModelImportForm):\n slug = SlugField()\n scope_type = CSVContentTypeField(\n queryset=ContentType.objects.filter(model__in=VLANGROUP_SCOPE_TYPES),\n required=False,\n label=_('Scope type (app & model)')\n )\n min_vid = forms.IntegerField(\n min_value=VLAN_VID_MIN,\n max_value=VLAN_VID_MAX,\n required=False,\n label=f'Minimum child VLAN VID (default: {VLAN_VID_MIN})'\n )\n max_vid = forms.IntegerField(\n min_value=VLAN_VID_MIN,\n max_value=VLAN_VID_MAX,\n required=False,\n label=f'Maximum child VLAN VID (default: {VLAN_VID_MIN})'\n )\n\n class Meta:\n model = VLANGroup\n fields = ('name', 'slug', 'scope_type', 'scope_id', 'min_vid', 'max_vid', 'description', 'tags')\n labels = {\n 'scope_id': 'Scope ID',\n }\n\n\nclass VLANImportForm(NetBoxModelImportForm):\n site = CSVModelChoiceField(\n queryset=Site.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned site')\n )\n group = CSVModelChoiceField(\n queryset=VLANGroup.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned VLAN group')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=VLANStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = VLAN\n fields = ('site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description', 'comments', 'tags')\n help_texts = {\n 'vid': 'Numeric VLAN ID (1-4094)',\n 'name': 'VLAN name',\n }\n\n\nclass ServiceTemplateImportForm(NetBoxModelImportForm):\n protocol = CSVChoiceField(\n choices=ServiceProtocolChoices,\n help_text=_('IP protocol')\n )\n\n class Meta:\n model = ServiceTemplate\n fields = ('name', 'protocol', 'ports', 'description', 'comments', 'tags')\n\n\nclass ServiceImportForm(NetBoxModelImportForm):\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Required if not assigned to a VM')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Required if not assigned to a device')\n )\n protocol = CSVChoiceField(\n choices=ServiceProtocolChoices,\n help_text=_('IP protocol')\n )\n\n class Meta:\n model = Service\n fields = ('device', 'virtual_machine', 'name', 'protocol', 'ports', 'description', 'comments', 'tags')\n\n\nclass L2VPNImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n )\n type = CSVChoiceField(\n choices=L2VPNTypeChoices,\n help_text=_('L2VPN type')\n )\n\n class Meta:\n model = L2VPN\n fields = ('identifier', 'name', 'slug', 'type', 'description', 'comments', 'tags')\n\n\nclass L2VPNTerminationImportForm(NetBoxModelImportForm):\n l2vpn = CSVModelChoiceField(\n queryset=L2VPN.objects.all(),\n required=True,\n to_field_name='name',\n label=_('L2VPN'),\n )\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent device (for interface)')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent virtual machine (for interface)')\n )\n interface = CSVModelChoiceField(\n queryset=Interface.objects.none(), # Can also refer to VMInterface\n required=False,\n to_field_name='name',\n help_text=_('Assigned interface (device or VM)')\n )\n vlan = CSVModelChoiceField(\n queryset=VLAN.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned VLAN')\n )\n\n class Meta:\n model = L2VPNTermination\n fields = ('l2vpn', 'device', 'virtual_machine', 'interface', 'vlan', 'tags')\n\n def __init__(self, data=None, args, *kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit interface queryset by device or VM\n if data.get('device'):\n self.fields['interface'].queryset = Interface.objects.filter(\n {f\"device__{self.fields['device'].to_field_name}\": data['device']}\n )\n elif data.get('virtual_machine'):\n self.fields['interface'].queryset = VMInterface.objects.filter(\n **{f\"virtual_machine__{self.fields['virtual_machine'].to_field_name}\": data['virtual_machine']}\n )\n\n def clean(self):\n super().clean()\n\n if self.cleaned_data.get('device') and self.cleaned_data.get('virtual_machine'):\n raise ValidationError('Cannot import device and VM interface terminations simultaneously.')\n if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')):\n raise ValidationError('Each termination must specify either an interface or a VLAN.')\n if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'):\n raise ValidationError('Cannot assign both an interface and a VLAN.')\n\n self.instance.assigned_object = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')\n", "path": "netbox/ipam/forms/bulk_import.py" } ]	[ { "content": "from django import forms\nfrom django.contrib.contenttypes.models import ContentType\nfrom django.core.exceptions import ValidationError\nfrom django.utils.translation import gettext as _\n\nfrom dcim.models import Device, Interface, Site\nfrom ipam.choices import \nfrom ipam.constants import \nfrom ipam.models import \nfrom netbox.forms import NetBoxModelImportForm\nfrom tenancy.models import Tenant\nfrom utilities.forms import CSVChoiceField, CSVContentTypeField, CSVModelChoiceField, SlugField\nfrom virtualization.models import VirtualMachine, VMInterface\n\n__all__ = (\n 'AggregateImportForm',\n 'ASNImportForm',\n 'FHRPGroupImportForm',\n 'IPAddressImportForm',\n 'IPRangeImportForm',\n 'L2VPNImportForm',\n 'L2VPNTerminationImportForm',\n 'PrefixImportForm',\n 'RIRImportForm',\n 'RoleImportForm',\n 'RouteTargetImportForm',\n 'ServiceImportForm',\n 'ServiceTemplateImportForm',\n 'VLANImportForm',\n 'VLANGroupImportForm',\n 'VRFImportForm',\n)\n\n\nclass VRFImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = VRF\n fields = ('name', 'rd', 'tenant', 'enforce_unique', 'description', 'comments', 'tags')\n\n\nclass RouteTargetImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = RouteTarget\n fields = ('name', 'tenant', 'description', 'comments', 'tags')\n\n\nclass RIRImportForm(NetBoxModelImportForm):\n slug = SlugField()\n\n class Meta:\n model = RIR\n fields = ('name', 'slug', 'is_private', 'description', 'tags')\n help_texts = {\n 'name': _('RIR name'),\n }\n\n\nclass AggregateImportForm(NetBoxModelImportForm):\n rir = CSVModelChoiceField(\n queryset=RIR.objects.all(),\n to_field_name='name',\n help_text=_('Assigned RIR')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = Aggregate\n fields = ('prefix', 'rir', 'tenant', 'date_added', 'description', 'comments', 'tags')\n\n\nclass ASNImportForm(NetBoxModelImportForm):\n rir = CSVModelChoiceField(\n queryset=RIR.objects.all(),\n to_field_name='name',\n help_text=_('Assigned RIR')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n\n class Meta:\n model = ASN\n fields = ('asn', 'rir', 'tenant', 'description', 'comments', 'tags')\n\n\nclass RoleImportForm(NetBoxModelImportForm):\n slug = SlugField()\n\n class Meta:\n model = Role\n fields = ('name', 'slug', 'weight', 'description', 'tags')\n\n\nclass PrefixImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n site = CSVModelChoiceField(\n queryset=Site.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned site')\n )\n vlan_group = CSVModelChoiceField(\n queryset=VLANGroup.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_(\"VLAN's group (if any)\")\n )\n vlan = CSVModelChoiceField(\n queryset=VLAN.objects.all(),\n required=False,\n to_field_name='vid',\n help_text=_(\"Assigned VLAN\")\n )\n status = CSVChoiceField(\n choices=PrefixStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = Prefix\n fields = (\n 'prefix', 'vrf', 'tenant', 'site', 'vlan_group', 'vlan', 'status', 'role', 'is_pool', 'mark_utilized',\n 'description', 'comments', 'tags',\n )\n\n def __init__(self, data=None, args, *kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit VLAN queryset by assigned site and/or group (if specified)\n params = {}\n if data.get('site'):\n params[f\"site__{self.fields['site'].to_field_name}\"] = data.get('site')\n if data.get('vlan_group'):\n params[f\"group__{self.fields['vlan_group'].to_field_name}\"] = data.get('vlan_group')\n if params:\n self.fields['vlan'].queryset = self.fields['vlan'].queryset.filter(params)\n\n\nclass IPRangeImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=IPRangeStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = IPRange\n fields = (\n 'start_address', 'end_address', 'vrf', 'tenant', 'status', 'role', 'description', 'comments', 'tags',\n )\n\n\nclass IPAddressImportForm(NetBoxModelImportForm):\n vrf = CSVModelChoiceField(\n queryset=VRF.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned VRF')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=IPAddressStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVChoiceField(\n choices=IPAddressRoleChoices,\n required=False,\n help_text=_('Functional role')\n )\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent device of assigned interface (if any)')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent VM of assigned interface (if any)')\n )\n interface = CSVModelChoiceField(\n queryset=Interface.objects.none(), # Can also refer to VMInterface\n required=False,\n to_field_name='name',\n help_text=_('Assigned interface')\n )\n is_primary = forms.BooleanField(\n help_text=_('Make this the primary IP for the assigned device'),\n required=False\n )\n\n class Meta:\n model = IPAddress\n fields = [\n 'address', 'vrf', 'tenant', 'status', 'role', 'device', 'virtual_machine', 'interface', 'is_primary',\n 'dns_name', 'description', 'comments', 'tags',\n ]\n\n def __init__(self, data=None, args, kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit interface queryset by assigned device\n if data.get('device'):\n self.fields['interface'].queryset = Interface.objects.filter(\n {f\"device__{self.fields['device'].to_field_name}\": data['device']}\n )\n\n # Limit interface queryset by assigned device\n elif data.get('virtual_machine'):\n self.fields['interface'].queryset = VMInterface.objects.filter(\n *{f\"virtual_machine__{self.fields['virtual_machine'].to_field_name}\": data['virtual_machine']}\n )\n\n def clean(self):\n super().clean()\n\n device = self.cleaned_data.get('device')\n virtual_machine = self.cleaned_data.get('virtual_machine')\n interface = self.cleaned_data.get('interface')\n is_primary = self.cleaned_data.get('is_primary')\n\n # Validate is_primary\n if is_primary and not device and not virtual_machine:\n raise forms.ValidationError({\n \"is_primary\": \"No device or virtual machine specified; cannot set as primary IP\"\n })\n if is_primary and not interface:\n raise forms.ValidationError({\n \"is_primary\": \"No interface specified; cannot set as primary IP\"\n })\n\n def save(self, args, *kwargs):\n\n # Set interface assignment\n if self.cleaned_data.get('interface'):\n self.instance.assigned_object = self.cleaned_data['interface']\n\n ipaddress = super().save(args, *kwargs)\n\n # Set as primary for device/VM\n if self.cleaned_data.get('is_primary'):\n parent = self.cleaned_data['device'] or self.cleaned_data['virtual_machine']\n if self.instance.address.version == 4:\n parent.primary_ip4 = ipaddress\n elif self.instance.address.version == 6:\n parent.primary_ip6 = ipaddress\n parent.save()\n\n return ipaddress\n\n\nclass FHRPGroupImportForm(NetBoxModelImportForm):\n protocol = CSVChoiceField(\n choices=FHRPGroupProtocolChoices\n )\n auth_type = CSVChoiceField(\n choices=FHRPGroupAuthTypeChoices,\n required=False\n )\n\n class Meta:\n model = FHRPGroup\n fields = ('protocol', 'group_id', 'auth_type', 'auth_key', 'name', 'description', 'comments', 'tags')\n\n\nclass VLANGroupImportForm(NetBoxModelImportForm):\n slug = SlugField()\n scope_type = CSVContentTypeField(\n queryset=ContentType.objects.filter(model__in=VLANGROUP_SCOPE_TYPES),\n required=False,\n label=_('Scope type (app & model)')\n )\n min_vid = forms.IntegerField(\n min_value=VLAN_VID_MIN,\n max_value=VLAN_VID_MAX,\n required=False,\n label=f'Minimum child VLAN VID (default: {VLAN_VID_MIN})'\n )\n max_vid = forms.IntegerField(\n min_value=VLAN_VID_MIN,\n max_value=VLAN_VID_MAX,\n required=False,\n label=f'Maximum child VLAN VID (default: {VLAN_VID_MIN})'\n )\n\n class Meta:\n model = VLANGroup\n fields = ('name', 'slug', 'scope_type', 'scope_id', 'min_vid', 'max_vid', 'description', 'tags')\n labels = {\n 'scope_id': 'Scope ID',\n }\n\n\nclass VLANImportForm(NetBoxModelImportForm):\n site = CSVModelChoiceField(\n queryset=Site.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned site')\n )\n group = CSVModelChoiceField(\n queryset=VLANGroup.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned VLAN group')\n )\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n to_field_name='name',\n required=False,\n help_text=_('Assigned tenant')\n )\n status = CSVChoiceField(\n choices=VLANStatusChoices,\n help_text=_('Operational status')\n )\n role = CSVModelChoiceField(\n queryset=Role.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Functional role')\n )\n\n class Meta:\n model = VLAN\n fields = ('site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description', 'comments', 'tags')\n help_texts = {\n 'vid': 'Numeric VLAN ID (1-4094)',\n 'name': 'VLAN name',\n }\n\n\nclass ServiceTemplateImportForm(NetBoxModelImportForm):\n protocol = CSVChoiceField(\n choices=ServiceProtocolChoices,\n help_text=_('IP protocol')\n )\n\n class Meta:\n model = ServiceTemplate\n fields = ('name', 'protocol', 'ports', 'description', 'comments', 'tags')\n\n\nclass ServiceImportForm(NetBoxModelImportForm):\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Required if not assigned to a VM')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Required if not assigned to a device')\n )\n protocol = CSVChoiceField(\n choices=ServiceProtocolChoices,\n help_text=_('IP protocol')\n )\n\n class Meta:\n model = Service\n fields = ('device', 'virtual_machine', 'name', 'protocol', 'ports', 'description', 'comments', 'tags')\n\n\nclass L2VPNImportForm(NetBoxModelImportForm):\n tenant = CSVModelChoiceField(\n queryset=Tenant.objects.all(),\n required=False,\n to_field_name='name',\n )\n type = CSVChoiceField(\n choices=L2VPNTypeChoices,\n help_text=_('L2VPN type')\n )\n\n class Meta:\n model = L2VPN\n fields = ('identifier', 'name', 'slug', 'tenant', 'type', 'description',\n 'comments', 'tags')\n\n\nclass L2VPNTerminationImportForm(NetBoxModelImportForm):\n l2vpn = CSVModelChoiceField(\n queryset=L2VPN.objects.all(),\n required=True,\n to_field_name='name',\n label=_('L2VPN'),\n )\n device = CSVModelChoiceField(\n queryset=Device.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent device (for interface)')\n )\n virtual_machine = CSVModelChoiceField(\n queryset=VirtualMachine.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Parent virtual machine (for interface)')\n )\n interface = CSVModelChoiceField(\n queryset=Interface.objects.none(), # Can also refer to VMInterface\n required=False,\n to_field_name='name',\n help_text=_('Assigned interface (device or VM)')\n )\n vlan = CSVModelChoiceField(\n queryset=VLAN.objects.all(),\n required=False,\n to_field_name='name',\n help_text=_('Assigned VLAN')\n )\n\n class Meta:\n model = L2VPNTermination\n fields = ('l2vpn', 'device', 'virtual_machine', 'interface', 'vlan', 'tags')\n\n def __init__(self, data=None, args, *kwargs):\n super().__init__(data, args, kwargs)\n\n if data:\n\n # Limit interface queryset by device or VM\n if data.get('device'):\n self.fields['interface'].queryset = Interface.objects.filter(\n {f\"device__{self.fields['device'].to_field_name}\": data['device']}\n )\n elif data.get('virtual_machine'):\n self.fields['interface'].queryset = VMInterface.objects.filter(\n **{f\"virtual_machine__{self.fields['virtual_machine'].to_field_name}\": data['virtual_machine']}\n )\n\n def clean(self):\n super().clean()\n\n if self.cleaned_data.get('device') and self.cleaned_data.get('virtual_machine'):\n raise ValidationError('Cannot import device and VM interface terminations simultaneously.')\n if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')):\n raise ValidationError('Each termination must specify either an interface or a VLAN.')\n if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'):\n raise ValidationError('Cannot assign both an interface and a VLAN.')\n\n self.instance.assigned_object = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')\n", "path": "netbox/ipam/forms/bulk_import.py" } ]	diff --git a/netbox/ipam/forms/bulk_import.py b/netbox/ipam/forms/bulk_import.py index 972b98db233..6546722ca36 100644 --- a/netbox/ipam/forms/bulk_import.py +++ b/netbox/ipam/forms/bulk_import.py @@ -443,7 +443,8 @@ class L2VPNImportForm(NetBoxModelImportForm): class Meta: model = L2VPN - fields = ('identifier', 'name', 'slug', 'type', 'description', 'comments', 'tags') + fields = ('identifier', 'name', 'slug', 'tenant', 'type', 'description', + 'comments', 'tags') class L2VPNTerminationImportForm(NetBoxModelImportForm):
mosaicml__composer-2108	Less strict numpy version pinning ## 🚀 Feature Request Allow for newer numpy versions than `<1.23.0`. ## Motivation Currently, composer fixes numpy to be `'numpy>=1.21.5,<1.23.0'`. This is unfortunate, because other requirements that we use need numpy > 1.23.0, creating an incompatibility. This was set in #1345 in reaction to a build failure because scipy need(ed) `<1.23.0`. Scipy itself is apparently pulled from `torch-metrics`. I don't believe this is current anymore: - composer pulls in `torchmetrics>=0.10.0,<0.11.4` - torchmetrics 0.11.3 pulls in `scipy >1.0.0, <=1.10.0` [(requirements)](https://github.com/Lightning-AI/metrics/blob/v0.11.3/requirements/image.txt#LL4C23-L4C23) - scipy 1.10.0 sets `np_maxversion = '1.27.0'` [(setup.py)](https://github.com/scipy/scipy/blob/v1.10.0/setup.py#L453) Indeed, scipy has https://github.com/scipy/scipy/issues/16964, which was fixed in https://github.com/scipy/scipy/pull/16966 in September of 2022, while #1345 above was noted in August. Accordingly, it looks like relaxing the numpy maxversion should have a valid requirements path. The closed PR https://github.com/mosaicml/composer/pull/1835 would already implement this.	[ { "content": "# Copyright 2022 MosaicML Composer authors\n# SPDX-License-Identifier: Apache-2.0\n\n\"\"\"Composer package setup.\"\"\"\n\nimport os\nimport site\nimport sys\nimport textwrap\n\nimport setuptools\nfrom setuptools import setup\nfrom setuptools.command.develop import develop as develop_orig\n\n# Read the composer version\n# Cannot import from `composer.__version__` since that will not be available when building or installing the package\nwith open(os.path.join(os.path.dirname(__file__), 'composer', '_version.py')) as f:\n version_globals = {}\n version_locals = {}\n exec(f.read(), version_globals, version_locals)\n composer_version = version_locals['__version__']\n\n_IS_ROOT = os.getuid() == 0\n_IS_USER = '--user' in sys.argv[1:]\n_IS_VIRTUALENV = 'VIRTUAL_ENV' in os.environ\n\n\n# From https://stackoverflow.com/questions/51292333/how-to-tell-from-setup-py-if-the-module-is-being-installed-in-editable-mode\nclass develop(develop_orig):\n \"\"\"Override the ``develop`` class to error if attempting an editable install as root.\"\"\"\n\n def run(self):\n if _IS_ROOT and (not _IS_VIRTUALENV) and (not _IS_USER):\n raise RuntimeError(\n textwrap.dedent(\"\"\"\\\n When installing in editable mode as root outside of a virtual environment,\n please specify `--user`. Editable installs as the root user outside of a virtual environment\n do not work without the `--user` flag. Please instead run something like: `pip install --user -e .`\"\"\"\n ))\n super().run()\n\n\n# From https://github.com/pypa/pip/issues/7953#issuecomment-645133255\nsite.ENABLE_USER_SITE = _IS_USER\n\n\ndef package_files(prefix: str, directory: str, extension: str):\n \"\"\"Get all the files to package.\"\"\"\n # from https://stackoverflow.com/a/36693250\n paths = []\n for (path, _, filenames) in os.walk(os.path.join(prefix, directory)):\n for filename in filenames:\n if filename.endswith(extension):\n paths.append(os.path.relpath(os.path.join(path, filename), prefix))\n return paths\n\n\nwith open('README.md', 'r', encoding='utf-8') as fh:\n long_description = fh.read()\n\n# Hide the content between <!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_BEGIN --> and\n# <!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_END --> tags in the README\nwhile True:\n start_tag = '<!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_BEGIN -->'\n end_tag = '<!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_END -->'\n start = long_description.find(start_tag)\n end = long_description.find(end_tag)\n if start == -1:\n assert end == -1, 'there should be a balanced number of start and ends'\n break\n else:\n assert end != -1, 'there should be a balanced number of start and ends'\n long_description = long_description[:start] + long_description[end + len(end_tag):]\n\ninstall_requires = [\n 'pyyaml>=6.0,<7',\n 'tqdm>=4.62.3,<5',\n 'torchmetrics>=0.10.0,<0.11.4',\n 'torch_optimizer>=0.3.0,<0.4',\n 'torchvision>=0.11.0,<0.15',\n 'torch>=1.10.0,<1.14',\n 'requests>=2.26.0,<3',\n 'numpy>=1.21.5,<1.23.0',\n 'psutil>=5.8.0,<6',\n 'coolname>=1.1.0,<3',\n 'tabulate==0.9.0', # for auto-generating tables\n 'py-cpuinfo>=8.0.0,<10',\n 'packaging>=21.3.0,<23',\n 'importlib-metadata>=5.0.0,<7',\n]\nextra_deps = {}\n\nextra_deps['base'] = []\n\nextra_deps['dev'] = [\n # Imports for docs builds and running tests\n # Pinning versions strictly to avoid random test failures.\n # Should manually update dependency versions occassionally.\n 'custom_inherit==2.4.1',\n 'junitparser==2.8.0',\n 'coverage[toml]==7.2.2',\n 'fasteners==0.18', # object store tests require fasteners\n 'pytest==7.2.2',\n 'toml==0.10.2',\n 'ipython==8.11.0',\n 'ipykernel==6.20.1',\n 'jupyter==1.0.0',\n 'yamllint==1.30.0',\n 'recommonmark==0.7.1',\n 'sphinx==4.4.0',\n 'pre-commit>=2.18.1,<3',\n # embedding md in rst require docutils>=0.17. See\n # https://myst-parser.readthedocs.io/en/latest/sphinx/use.html?highlight=parser#include-markdown-files-into-an-rst-file\n 'docutils==0.17.1',\n 'sphinx_markdown_tables==0.0.17',\n 'sphinx-argparse==0.4.0',\n 'sphinxcontrib.katex==0.9.4',\n 'sphinxext.opengraph==0.7.4',\n 'sphinxemoji==0.2.0',\n 'furo==2022.9.29',\n 'sphinx-copybutton==0.5.0',\n 'testbook==0.4.2',\n 'myst-parser==0.16.1',\n 'sphinx_panels==0.6.0',\n 'sphinxcontrib-images==0.9.4',\n 'pytest_codeblocks==0.16.1',\n 'traitlets==5.9.0',\n 'nbsphinx==0.8.12',\n 'pandoc==2.3',\n 'pypandoc==1.11',\n 'GitPython==3.1.31',\n 'moto[s3]>=4.0.1,<5',\n 'mock-ssh-server==0.9.1',\n 'cryptography==38.0.4',\n 'pytest-httpserver>=1.0.4,<1.1',\n 'setuptools<=59.5.0',\n]\n\nextra_deps['health_checker'] = {\n 'pynvml>=11.5.0,<12',\n 'slack_sdk>=3.19.5,<4',\n}\n\nextra_deps['deepspeed'] = [\n 'deepspeed==0.7.7',\n]\n\nextra_deps['wandb'] = [\n 'wandb>=0.13.2,<0.14',\n]\n\nextra_deps['comet_ml'] = [\n 'comet_ml>=3.31.12,<4.0.0',\n]\n\nextra_deps['tensorboard'] = [\n 'tensorboard>=2.9.1,<3.0.0',\n]\n\nextra_deps['unet'] = [\n 'monai>=0.9.1,<1.2',\n 'scikit-learn>=1.0.1,<2',\n]\n\nextra_deps['vit'] = [\n 'vit_pytorch==0.35.8',\n]\n\nextra_deps['timm'] = [\n 'timm>=0.5.4,<0.6',\n]\n\nextra_deps['coco'] = [\n 'pycocotools>=2.0.4,<3',\n]\n\nextra_deps['nlp'] = [\n 'transformers>=4.11,<4.27.5',\n 'datasets>=2.4,<3',\n]\n\nextra_deps['sentencepiece'] = ['sentencepiece==0.1.97']\n\nextra_deps['mlperf'] = [\n # TODO: use pip when available: https://github.com/mlcommons/logging/issues/218\n # \"mlperf_logging @ git+https://github.com/mlperf/logging.git\",\n 'py-cpuinfo>=8.0.0,<10',\n]\n\nextra_deps['streaming'] = [\n 'mosaicml-streaming<0.4',\n 'boto3>=1.21.45,<2',\n 'paramiko>=2.11.0,<3',\n]\n\nextra_deps['libcloud'] = [\n 'apache-libcloud>=3.3.1,<4',\n]\n\nextra_deps['oci'] = [\n 'oci>=2.88.2,<3.0.0',\n]\n\nextra_deps['onnx'] = [\n 'onnx>=1.12.0,<2',\n 'onnxruntime>=1.12.1,<2',\n]\n\nextra_deps['mlflow'] = ['mlflow>=2.0.1,<3.0']\n\nextra_deps['all'] = set(dep for deps in extra_deps.values() for dep in deps)\n\ncomposer_data_files = ['py.typed']\ncomposer_data_files += package_files('composer', 'yamls', '.yaml')\ncomposer_data_files += package_files('composer', 'algorithms', '.json')\n\npackage_name = os.environ.get('COMPOSER_PACKAGE_NAME', 'mosaicml')\n\nif package_name != 'mosaicml':\n print(f'`Building composer as `{package_name}`)', file=sys.stderr)\n\nsetup(name=package_name,\n version=composer_version,\n author='MosaicML',\n author_email='[email protected]',\n description=('Composer is a PyTorch library that enables you to train ' +\n 'neural networks faster, at lower cost, and to higher accuracy.'),\n long_description=long_description,\n long_description_content_type='text/markdown',\n url='https://github.com/mosaicml/composer',\n include_package_data=True,\n package_data={\n 'composer': composer_data_files,\n },\n packages=setuptools.find_packages(exclude=['docker', 'examples', 'scripts', 'tests']),\n classifiers=[\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n ],\n install_requires=install_requires,\n entry_points={\n 'console_scripts': [\n 'composer = composer.cli.launcher:main',\n 'composer_collect_env = composer.utils.collect_env:main',\n ],\n },\n extras_require=extra_deps,\n dependency_links=['https://developer.download.nvidia.com/compute/redist'],\n python_requires='>=3.8',\n ext_package='composer',\n cmdclass={'develop': develop})\n\n# only visible if user installs with verbose -v flag\n# Printing to stdout as not to interfere with setup.py CLI flags (e.g. --version)\nprint('' 20, file=sys.stderr)\nprint(textwrap.dedent(\"\"\"\\\n NOTE: For best performance, we recommend installing Pillow-SIMD\n for accelerated image processing operations. To install:\n \\t pip uninstall pillow && pip install pillow-simd\"\"\"),\n file=sys.stderr)\nprint('' 20, file=sys.stderr)\n", "path": "setup.py" } ]	[ { "content": "# Copyright 2022 MosaicML Composer authors\n# SPDX-License-Identifier: Apache-2.0\n\n\"\"\"Composer package setup.\"\"\"\n\nimport os\nimport site\nimport sys\nimport textwrap\n\nimport setuptools\nfrom setuptools import setup\nfrom setuptools.command.develop import develop as develop_orig\n\n# Read the composer version\n# Cannot import from `composer.__version__` since that will not be available when building or installing the package\nwith open(os.path.join(os.path.dirname(__file__), 'composer', '_version.py')) as f:\n version_globals = {}\n version_locals = {}\n exec(f.read(), version_globals, version_locals)\n composer_version = version_locals['__version__']\n\n_IS_ROOT = os.getuid() == 0\n_IS_USER = '--user' in sys.argv[1:]\n_IS_VIRTUALENV = 'VIRTUAL_ENV' in os.environ\n\n\n# From https://stackoverflow.com/questions/51292333/how-to-tell-from-setup-py-if-the-module-is-being-installed-in-editable-mode\nclass develop(develop_orig):\n \"\"\"Override the ``develop`` class to error if attempting an editable install as root.\"\"\"\n\n def run(self):\n if _IS_ROOT and (not _IS_VIRTUALENV) and (not _IS_USER):\n raise RuntimeError(\n textwrap.dedent(\"\"\"\\\n When installing in editable mode as root outside of a virtual environment,\n please specify `--user`. Editable installs as the root user outside of a virtual environment\n do not work without the `--user` flag. Please instead run something like: `pip install --user -e .`\"\"\"\n ))\n super().run()\n\n\n# From https://github.com/pypa/pip/issues/7953#issuecomment-645133255\nsite.ENABLE_USER_SITE = _IS_USER\n\n\ndef package_files(prefix: str, directory: str, extension: str):\n \"\"\"Get all the files to package.\"\"\"\n # from https://stackoverflow.com/a/36693250\n paths = []\n for (path, _, filenames) in os.walk(os.path.join(prefix, directory)):\n for filename in filenames:\n if filename.endswith(extension):\n paths.append(os.path.relpath(os.path.join(path, filename), prefix))\n return paths\n\n\nwith open('README.md', 'r', encoding='utf-8') as fh:\n long_description = fh.read()\n\n# Hide the content between <!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_BEGIN --> and\n# <!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_END --> tags in the README\nwhile True:\n start_tag = '<!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_BEGIN -->'\n end_tag = '<!-- SETUPTOOLS_LONG_DESCRIPTION_HIDE_END -->'\n start = long_description.find(start_tag)\n end = long_description.find(end_tag)\n if start == -1:\n assert end == -1, 'there should be a balanced number of start and ends'\n break\n else:\n assert end != -1, 'there should be a balanced number of start and ends'\n long_description = long_description[:start] + long_description[end + len(end_tag):]\n\ninstall_requires = [\n 'pyyaml>=6.0,<7',\n 'tqdm>=4.62.3,<5',\n 'torchmetrics>=0.10.0,<0.11.4',\n 'torch_optimizer>=0.3.0,<0.4',\n 'torchvision>=0.11.0,<0.15',\n 'torch>=1.10.0,<1.14',\n 'requests>=2.26.0,<3',\n 'numpy>=1.21.5,<1.25.0',\n 'psutil>=5.8.0,<6',\n 'coolname>=1.1.0,<3',\n 'tabulate==0.9.0', # for auto-generating tables\n 'py-cpuinfo>=8.0.0,<10',\n 'packaging>=21.3.0,<23',\n 'importlib-metadata>=5.0.0,<7',\n]\nextra_deps = {}\n\nextra_deps['base'] = []\n\nextra_deps['dev'] = [\n # Imports for docs builds and running tests\n # Pinning versions strictly to avoid random test failures.\n # Should manually update dependency versions occassionally.\n 'custom_inherit==2.4.1',\n 'junitparser==2.8.0',\n 'coverage[toml]==7.2.2',\n 'fasteners==0.18', # object store tests require fasteners\n 'pytest==7.2.2',\n 'toml==0.10.2',\n 'ipython==8.11.0',\n 'ipykernel==6.20.1',\n 'jupyter==1.0.0',\n 'yamllint==1.30.0',\n 'recommonmark==0.7.1',\n 'sphinx==4.4.0',\n 'pre-commit>=2.18.1,<3',\n # embedding md in rst require docutils>=0.17. See\n # https://myst-parser.readthedocs.io/en/latest/sphinx/use.html?highlight=parser#include-markdown-files-into-an-rst-file\n 'docutils==0.17.1',\n 'sphinx_markdown_tables==0.0.17',\n 'sphinx-argparse==0.4.0',\n 'sphinxcontrib.katex==0.9.4',\n 'sphinxext.opengraph==0.7.4',\n 'sphinxemoji==0.2.0',\n 'furo==2022.9.29',\n 'sphinx-copybutton==0.5.0',\n 'testbook==0.4.2',\n 'myst-parser==0.16.1',\n 'sphinx_panels==0.6.0',\n 'sphinxcontrib-images==0.9.4',\n 'pytest_codeblocks==0.16.1',\n 'traitlets==5.9.0',\n 'nbsphinx==0.8.12',\n 'pandoc==2.3',\n 'pypandoc==1.11',\n 'GitPython==3.1.31',\n 'moto[s3]>=4.0.1,<5',\n 'mock-ssh-server==0.9.1',\n 'cryptography==38.0.4',\n 'pytest-httpserver>=1.0.4,<1.1',\n 'setuptools<=59.5.0',\n]\n\nextra_deps['health_checker'] = {\n 'pynvml>=11.5.0,<12',\n 'slack_sdk>=3.19.5,<4',\n}\n\nextra_deps['deepspeed'] = [\n 'deepspeed==0.7.7',\n]\n\nextra_deps['wandb'] = [\n 'wandb>=0.13.2,<0.14',\n]\n\nextra_deps['comet_ml'] = [\n 'comet_ml>=3.31.12,<4.0.0',\n]\n\nextra_deps['tensorboard'] = [\n 'tensorboard>=2.9.1,<3.0.0',\n]\n\nextra_deps['unet'] = [\n 'monai>=0.9.1,<1.2',\n 'scikit-learn>=1.0.1,<2',\n]\n\nextra_deps['vit'] = [\n 'vit_pytorch==0.35.8',\n]\n\nextra_deps['timm'] = [\n 'timm>=0.5.4,<0.6',\n]\n\nextra_deps['coco'] = [\n 'pycocotools>=2.0.4,<3',\n]\n\nextra_deps['nlp'] = [\n 'transformers>=4.11,<4.27.5',\n 'datasets>=2.4,<3',\n]\n\nextra_deps['sentencepiece'] = ['sentencepiece==0.1.97']\n\nextra_deps['mlperf'] = [\n # TODO: use pip when available: https://github.com/mlcommons/logging/issues/218\n # \"mlperf_logging @ git+https://github.com/mlperf/logging.git\",\n 'py-cpuinfo>=8.0.0,<10',\n]\n\nextra_deps['streaming'] = [\n 'mosaicml-streaming<0.4',\n 'boto3>=1.21.45,<2',\n 'paramiko>=2.11.0,<3',\n]\n\nextra_deps['libcloud'] = [\n 'apache-libcloud>=3.3.1,<4',\n]\n\nextra_deps['oci'] = [\n 'oci>=2.88.2,<3.0.0',\n]\n\nextra_deps['onnx'] = [\n 'onnx>=1.12.0,<2',\n 'onnxruntime>=1.12.1,<2',\n]\n\nextra_deps['mlflow'] = ['mlflow>=2.0.1,<3.0']\n\nextra_deps['all'] = set(dep for deps in extra_deps.values() for dep in deps)\n\ncomposer_data_files = ['py.typed']\ncomposer_data_files += package_files('composer', 'yamls', '.yaml')\ncomposer_data_files += package_files('composer', 'algorithms', '.json')\n\npackage_name = os.environ.get('COMPOSER_PACKAGE_NAME', 'mosaicml')\n\nif package_name != 'mosaicml':\n print(f'`Building composer as `{package_name}`)', file=sys.stderr)\n\nsetup(name=package_name,\n version=composer_version,\n author='MosaicML',\n author_email='[email protected]',\n description=('Composer is a PyTorch library that enables you to train ' +\n 'neural networks faster, at lower cost, and to higher accuracy.'),\n long_description=long_description,\n long_description_content_type='text/markdown',\n url='https://github.com/mosaicml/composer',\n include_package_data=True,\n package_data={\n 'composer': composer_data_files,\n },\n packages=setuptools.find_packages(exclude=['docker', 'examples', 'scripts', 'tests']),\n classifiers=[\n 'Programming Language :: Python :: 3',\n 'Programming Language :: Python :: 3.8',\n 'Programming Language :: Python :: 3.9',\n 'Programming Language :: Python :: 3.10',\n ],\n install_requires=install_requires,\n entry_points={\n 'console_scripts': [\n 'composer = composer.cli.launcher:main',\n 'composer_collect_env = composer.utils.collect_env:main',\n ],\n },\n extras_require=extra_deps,\n dependency_links=['https://developer.download.nvidia.com/compute/redist'],\n python_requires='>=3.8',\n ext_package='composer',\n cmdclass={'develop': develop})\n\n# only visible if user installs with verbose -v flag\n# Printing to stdout as not to interfere with setup.py CLI flags (e.g. --version)\nprint('' 20, file=sys.stderr)\nprint(textwrap.dedent(\"\"\"\\\n NOTE: For best performance, we recommend installing Pillow-SIMD\n for accelerated image processing operations. To install:\n \\t pip uninstall pillow && pip install pillow-simd\"\"\"),\n file=sys.stderr)\nprint('' 20, file=sys.stderr)\n", "path": "setup.py" } ]	diff --git a/setup.py b/setup.py index 40bf7709cb..89e03ce7e6 100644 --- a/setup.py +++ b/setup.py @@ -80,7 +80,7 @@ def package_files(prefix: str, directory: str, extension: str): 'torchvision>=0.11.0,<0.15', 'torch>=1.10.0,<1.14', 'requests>=2.26.0,<3', - 'numpy>=1.21.5,<1.23.0', + 'numpy>=1.21.5,<1.25.0', 'psutil>=5.8.0,<6', 'coolname>=1.1.0,<3', 'tabulate==0.9.0', # for auto-generating tables diff --git a/tests/trainer/test_sharded_checkpoint.py b/tests/trainer/test_sharded_checkpoint.py index 359e8c6045..c0ea610346 100644 --- a/tests/trainer/test_sharded_checkpoint.py +++ b/tests/trainer/test_sharded_checkpoint.py @@ -105,7 +105,7 @@ def test_fsdp_full_state_dict_save(world_size, tmp_path: pathlib.Path): expected_layer_shapes = [(5, num_features), (5,), (num_classes, 5), (num_classes,)] layer1_weights_shape, layer1_bias_shape, layer2_weights_shape, layer2_bias_shape = expected_layer_shapes - expected_total_num_params = sum([np.prod(shape) for shape in expected_layer_shapes]) + expected_total_num_params = sum([np.prod(shape) for shape in expected_layer_shapes]) # type: ignore trainer = get_trainer(save_folder=str(save_folder), save_filename=save_filename, @@ -230,7 +230,7 @@ def test_fsdp_partitioned_state_dict_save(world_size, tmp_path: pathlib.Path, st num_classes = 2 expected_layer_shapes = [(5, num_features), (5,), (num_classes, 5), (num_classes,)] - expected_total_num_params = sum([np.prod(shape) for shape in expected_layer_shapes]) + expected_total_num_params = sum([np.prod(shape) for shape in expected_layer_shapes]) # type: ignore trainer = get_trainer(save_folder=str(save_folder), save_filename=save_filename,
obspy__obspy-2344	fdsn EIDA routed client: problem with spammed subprocesses (memory leak) Issue reported on the users mailing list: ``` I am facing a potential issue with the ObsPy FDSN client. I am using the EIDA routing client to download waveform data and metadata for many stations. The way I do it is a simple loop over all stations, using the get_waveforms() function in the loop. In principle it looks like this: from obspy.clients.fdsn import RoutingClient as Client client = Client('eida-routing') for station in long_list : data = client.get_waveforms(...) data.write(filename) The problem is, that each time data is actually downloaded, ObsPy seems to start several new processes in the background, which are not being closed until the end of the python script. Thus, for each station in the for-loop new additional processes are started but not closed again. Since I have a very long stationlist and many days that I loop over, basically I end up spawning more processes than the systen can handle, ultimately resulting in the message: "Can't start new thread" This problem only occurs with the fdsn routing client, but e.g. not with the ArcLink client. I did not try the non-routed fdsn client. Same behaviour with ObsPy versions 1.1.0 and 1.1.1 ... ```	[ { "content": "#!/usr/bin/env python\n# -- coding: utf-8 --\n\"\"\"\nBase class for all FDSN routers.\n\n:copyright:\n The ObsPy Development Team ([email protected])\n Celso G Reyes, 2017\n IRIS-DMC\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_import, division, print_function,\n unicode_literals)\nfrom future.builtins import * # NOQA\n\nfrom multiprocessing.dummy import Pool as ThreadPool\n\nimport decorator\nimport io\nimport sys\nimport traceback\nimport warnings\n\nfrom obspy.core.compatibility import (urlparse, string_types,\n get_reason_from_response)\nimport obspy\n\nfrom ...base import HTTPClient\nfrom .. import client\nfrom ..client import raise_on_error\nfrom ..header import FDSNException, URL_MAPPINGS, FDSNNoDataException\n\n\ndef RoutingClient(routing_type, args, kwargs): # NOQA\n \"\"\"\n Helper function to get the correct routing instance.\n\n :type routing_type: str\n :param routing_type: The type of router to initialize.\n ``\"iris-federator\"`` or ``\"eida-routing\"``. Will consequently return\n either a :class:`~.federator_routing_client.FederatorRoutingClient` or\n a :class:`~.eidaws_routing_client.EIDAWSRoutingClient` object,\n respectively.\n\n Remaining ``args`` and ``kwargs`` will be passed to the underlying classes.\n For example, credentials can be supported for all underlying data centers.\n See :meth:`BaseRoutingClient <BaseRoutingClient.__init__>` for details.\n\n >>> from obspy.clients.fdsn import RoutingClient\n\n Get an instance of a routing client using the IRIS Federator:\n\n >>> c = RoutingClient(\"iris-federator\")\n >>> print(type(c)) # doctest: +ELLIPSIS\n <class '...routing.federator_routing_client.FederatorRoutingClient'>\n\n Or get an instance of a routing client using the EIDAWS routing web\n service:\n\n >>> c = RoutingClient(\"eida-routing\")\n >>> print(type(c)) # doctest: +ELLIPSIS\n <class '...routing.eidaws_routing_client.EIDAWSRoutingClient'>\n \"\"\"\n if routing_type.lower() == \"eida-routing\":\n from .eidaws_routing_client import EIDAWSRoutingClient\n return EIDAWSRoutingClient(args, *kwargs)\n if routing_type.lower() == \"iris-federator\":\n from .federator_routing_client import FederatorRoutingClient\n return FederatorRoutingClient(args, *kwargs)\n else:\n raise NotImplementedError(\n \"Routing type '%s' is not implemented. Available types: \"\n \"`iris-federator`, `eida-routing`\" % routing_type)\n\n\[email protected]\ndef _assert_filename_not_in_kwargs(f, args, *kwargs):\n if \"filename\" in kwargs:\n raise ValueError(\"The `filename` argument is not supported\")\n return f(args, *kwargs)\n\n\[email protected]\ndef _assert_attach_response_not_in_kwargs(f, args, *kwargs):\n if \"attach_response\" in kwargs:\n raise ValueError(\"The `attach_response` argument is not supported\")\n return f(args, *kwargs)\n\n\ndef _try_download_bulk(r):\n try:\n return _download_bulk(r)\n except Exception:\n reason = \"\".join(traceback.format_exception(sys.exc_info()))\n warnings.warn(\n \"Failed to download data of type '%s' from '%s' due to: \\n%s\" % (\n r[\"data_type\"], r[\"endpoint\"], reason))\n return None\n\n\ndef _download_bulk(r):\n # Figure out the passed credentials, if any. Two possibilities:\n # (1) User and password, given explicitly for the base URLs (or an\n # explicity given `eida_token` key per URL).\n # (2) A global EIDA_TOKEN key. It will be used for all services that\n # don't have explicit credentials and also support the `/auth` route.\n credentials = r[\"credentials\"].get(urlparse(r[\"endpoint\"]).netloc, {})\n try:\n c = client.Client(r[\"endpoint\"], debug=r[\"debug\"],\n timeout=r[\"timeout\"], credentials)\n # This should rarely happen but better safe than sorry.\n except FDSNException as e: # pragma: no cover\n msg = e.args[0]\n msg += \"It will not be used for routing. Try again later?\"\n warnings.warn(msg)\n return None\n\n if not credentials and \"EIDA_TOKEN\" in r[\"credentials\"] and \\\n c._has_eida_auth:\n c.set_eida_token(r[\"credentials\"][\"EIDA_TOKEN\"])\n\n if r[\"data_type\"] == \"waveform\":\n fct = c.get_waveforms_bulk\n service = c.services[\"dataselect\"]\n elif r[\"data_type\"] == \"station\":\n fct = c.get_stations_bulk\n service = c.services[\"station\"]\n\n # Keep only kwargs that are supported by this particular service.\n kwargs = {k: v for k, v in r[\"kwargs\"].items() if k in service}\n bulk_str = \"\"\n for key, value in kwargs.items():\n bulk_str += \"%s=%s\\n\" % (key, str(value))\n try:\n return fct(bulk_str + r[\"bulk_str\"])\n except FDSNException:\n return None\n\n\ndef _strip_protocol(url):\n url = urlparse(url)\n return url.netloc + url.path\n\n\n# Does not inherit from the FDSN client as that would be fairly hacky as\n# some methods just make no sense for the routing client to have (e.g.\n# get_events() but also others).\nclass BaseRoutingClient(HTTPClient):\n def __init__(self, debug=False, timeout=120, include_providers=None,\n exclude_providers=None, credentials=None):\n \"\"\"\n :type routing_type: str\n :param routing_type: The type of\n router to initialize. For details see :func:`RoutingClient`.\n :type exclude_providers: str or list of str\n :param exclude_providers: Get no data from these providers. Can be\n the full HTTP address or one of the shortcuts ObsPy knows about.\n :type include_providers: str or list of str\n :param include_providers: Get data only from these providers. Can be\n the full HTTP address of one of the shortcuts ObsPy knows about.\n :type credentials: dict\n :param credentials: Credentials for the individual data centers as a\n dictionary that maps base url of FDSN web service to either\n username/password or EIDA token, e.g.\n ``credentials={\n 'geofon.gfz-potsdam.de': {'eida_token': 'my_token_file.txt'},\n 'service.iris.edu': {'user': 'me', 'password': 'my_pass'}\n 'EIDA_TOKEN': '/path/to/token.txt'\n }``\n The root level ``'EIDA_TOKEN'`` will be applied to all data centers\n that claim to support the ``/auth`` route and don't have data\n center specific credentials.\n You can also use a URL mapping as for the normal FDSN client\n instead of the URL.\n \"\"\"\n HTTPClient.__init__(self, debug=debug, timeout=timeout)\n self.include_providers = include_providers\n self.exclude_providers = exclude_providers\n\n # Parse credentials.\n self.credentials = {}\n for key, value in (credentials or {}).items():\n if key == \"EIDA_TOKEN\":\n self.credentials[key] = value\n # Map, if necessary.\n if key in URL_MAPPINGS:\n key = URL_MAPPINGS[key]\n # Make sure urlparse works correctly.\n if not key.startswith(\"http\"):\n key = \"http://\" + key\n # Only use the location.\n self.credentials[urlparse(key).netloc] = value\n\n @property\n def include_providers(self):\n return self.__include_providers\n\n @include_providers.setter\n def include_providers(self, value):\n self.__include_providers = self._expand_providers(value)\n\n @property\n def exclude_providers(self):\n return self.__exclude_providers\n\n @exclude_providers.setter\n def exclude_providers(self, value):\n self.__exclude_providers = self._expand_providers(value)\n\n def _expand_providers(self, providers):\n if providers is None:\n providers = []\n elif isinstance(providers, string_types):\n providers = [providers]\n return [_strip_protocol(URL_MAPPINGS[_i])\n if _i in URL_MAPPINGS\n else _strip_protocol(_i) for _i in providers]\n\n def _filter_requests(self, split):\n \"\"\"\n Filter requests based on including and excluding providers.\n\n :type split: dict\n :param split: A dictionary containing the desired routing.\n \"\"\"\n key_map = {_strip_protocol(url): url for url in split.keys()}\n\n # Apply both filters.\n f_keys = set(key_map.keys())\n if self.include_providers:\n f_keys = f_keys.intersection(set(self.include_providers))\n f_keys = f_keys.difference(set(self.exclude_providers))\n\n return {key_map[k]: split[key_map[k]] for k in f_keys}\n\n def _download_waveforms(self, split, kwargs):\n return self._download_parallel(split, data_type=\"waveform\", kwargs)\n\n def _download_stations(self, split, kwargs):\n return self._download_parallel(split, data_type=\"station\", kwargs)\n\n def _download_parallel(self, split, data_type, kwargs):\n # Apply the provider filter.\n split = self._filter_requests(split)\n\n if not split:\n raise FDSNNoDataException(\n \"Nothing remains to download after the provider \"\n \"inclusion/exclusion filters have been applied.\")\n\n if data_type not in [\"waveform\", \"station\"]: # pragma: no cover\n raise ValueError(\"Invalid data type.\")\n\n # One thread per data center.\n dl_requests = []\n for k, v in split.items():\n dl_requests.append({\n \"debug\": self._debug,\n \"timeout\": self._timeout,\n \"endpoint\": k,\n \"bulk_str\": v,\n \"data_type\": data_type,\n \"kwargs\": kwargs,\n \"credentials\": self.credentials})\n pool = ThreadPool(processes=len(dl_requests))\n results = pool.map(_try_download_bulk, dl_requests)\n\n # Merge all results into a single object.\n if data_type == \"waveform\":\n collection = obspy.Stream()\n elif data_type == \"station\":\n collection = obspy.Inventory(\n networks=[],\n source=\"ObsPy FDSN Routing %s\" % obspy.__version__)\n else: # pragma: no cover\n raise ValueError\n\n for _i in results:\n if not _i:\n continue\n collection += _i\n\n return collection\n\n def _handle_requests_http_error(self, r):\n \"\"\"\n This assumes the same error code semantics as the base fdsnws web\n services.\n\n Please overwrite this method in a child class if necessary.\n \"\"\"\n reason = get_reason_from_response(r)\n if hasattr(r, \"content\"):\n c = r.content\n try:\n c = c.encode()\n except Exception:\n pass\n reason += b\" -- \" + c\n with io.BytesIO(reason) as buf:\n raise_on_error(r.status_code, buf)\n\n @_assert_filename_not_in_kwargs\n @_assert_attach_response_not_in_kwargs\n def get_waveforms(self, starttime, endtime, kwargs):\n \"\"\"\n Get waveforms from multiple data centers.\n\n Arguments are the same as in\n :meth:`obspy.clients.fdsn.client.Client.get_waveforms()`.\n Any additional ``kwargs`` are passed on to each individual service's\n dataselect service if the service supports them (otherwise they are\n silently ignored for that particular fdsnws endpoint).\n\n The ``filename`` and ``attach_response`` parameters of the single\n provider FDSN client are not supported.\n\n This can route on a number of different parameters, depending on the\n service, please see the web site of each individual routing service\n for details.\n \"\"\"\n # This just calls the bulk downloader to only implement the logic once.\n # Just pass these to the bulk request.\n bulk = []\n for _i in [\"network\", \"station\", \"location\", \"channel\"]:\n if _i in kwargs:\n bulk.append(kwargs[_i])\n del kwargs[_i]\n else:\n bulk.append(\"\")\n bulk.extend([starttime, endtime])\n return self.get_waveforms_bulk([bulk], kwargs)\n\n def get_service_version(self):\n \"\"\"\n Return a semantic version number of the remote service as a string.\n \"\"\"\n r = self._download(self._url + \"/version\")\n return r.content.decode() if \\\n hasattr(r.content, \"decode\") else r.content\n\n @_assert_filename_not_in_kwargs\n def get_stations(self, kwargs):\n \"\"\"\n Get stations from multiple data centers.\n\n It will pass on most parameters to the underlying routed service.\n They will also be passed on to the individual FDSNWS implementations\n if a service supports them.\n\n The ``filename`` parameter of the single provider FDSN client is not\n supported.\n\n This can route on a number of different parameters, please see the\n web sites of the\n `IRIS Federator <https://service.iris.edu/irisws/fedcatalog/1/>`_\n and of the `EIDAWS Routing Service\n <http://www.orfeus-eu.org/data/eida/webservices/routing/>`_ for\n details.\n \"\"\"\n # Just pass these to the bulk request.\n bulk = [kwargs.pop(key, '') for key in (\n \"network\", \"station\", \"location\", \"channel\", \"starttime\",\n \"endtime\")]\n return self.get_stations_bulk([bulk], **kwargs)\n\n\nif __name__ == '__main__': # pragma: no cover\n import doctest\n doctest.testmod(exclude_empty=True)\n", "path": "obspy/clients/fdsn/routing/routing_client.py" } ]	[ { "content": "#!/usr/bin/env python\n# -- coding: utf-8 --\n\"\"\"\nBase class for all FDSN routers.\n\n:copyright:\n The ObsPy Development Team ([email protected])\n Celso G Reyes, 2017\n IRIS-DMC\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_import, division, print_function,\n unicode_literals)\nfrom future.builtins import * # NOQA\n\nfrom multiprocessing.dummy import Pool as ThreadPool\n\nimport decorator\nimport io\nimport sys\nimport traceback\nimport warnings\n\nfrom obspy.core.compatibility import (urlparse, string_types,\n get_reason_from_response)\nimport obspy\n\nfrom ...base import HTTPClient\nfrom .. import client\nfrom ..client import raise_on_error\nfrom ..header import FDSNException, URL_MAPPINGS, FDSNNoDataException\n\n\ndef RoutingClient(routing_type, args, kwargs): # NOQA\n \"\"\"\n Helper function to get the correct routing instance.\n\n :type routing_type: str\n :param routing_type: The type of router to initialize.\n ``\"iris-federator\"`` or ``\"eida-routing\"``. Will consequently return\n either a :class:`~.federator_routing_client.FederatorRoutingClient` or\n a :class:`~.eidaws_routing_client.EIDAWSRoutingClient` object,\n respectively.\n\n Remaining ``args`` and ``kwargs`` will be passed to the underlying classes.\n For example, credentials can be supported for all underlying data centers.\n See :meth:`BaseRoutingClient <BaseRoutingClient.__init__>` for details.\n\n >>> from obspy.clients.fdsn import RoutingClient\n\n Get an instance of a routing client using the IRIS Federator:\n\n >>> c = RoutingClient(\"iris-federator\")\n >>> print(type(c)) # doctest: +ELLIPSIS\n <class '...routing.federator_routing_client.FederatorRoutingClient'>\n\n Or get an instance of a routing client using the EIDAWS routing web\n service:\n\n >>> c = RoutingClient(\"eida-routing\")\n >>> print(type(c)) # doctest: +ELLIPSIS\n <class '...routing.eidaws_routing_client.EIDAWSRoutingClient'>\n \"\"\"\n if routing_type.lower() == \"eida-routing\":\n from .eidaws_routing_client import EIDAWSRoutingClient\n return EIDAWSRoutingClient(args, *kwargs)\n if routing_type.lower() == \"iris-federator\":\n from .federator_routing_client import FederatorRoutingClient\n return FederatorRoutingClient(args, *kwargs)\n else:\n raise NotImplementedError(\n \"Routing type '%s' is not implemented. Available types: \"\n \"`iris-federator`, `eida-routing`\" % routing_type)\n\n\[email protected]\ndef _assert_filename_not_in_kwargs(f, args, *kwargs):\n if \"filename\" in kwargs:\n raise ValueError(\"The `filename` argument is not supported\")\n return f(args, *kwargs)\n\n\[email protected]\ndef _assert_attach_response_not_in_kwargs(f, args, *kwargs):\n if \"attach_response\" in kwargs:\n raise ValueError(\"The `attach_response` argument is not supported\")\n return f(args, *kwargs)\n\n\ndef _try_download_bulk(r):\n try:\n return _download_bulk(r)\n except Exception:\n reason = \"\".join(traceback.format_exception(sys.exc_info()))\n warnings.warn(\n \"Failed to download data of type '%s' from '%s' due to: \\n%s\" % (\n r[\"data_type\"], r[\"endpoint\"], reason))\n return None\n\n\ndef _download_bulk(r):\n # Figure out the passed credentials, if any. Two possibilities:\n # (1) User and password, given explicitly for the base URLs (or an\n # explicity given `eida_token` key per URL).\n # (2) A global EIDA_TOKEN key. It will be used for all services that\n # don't have explicit credentials and also support the `/auth` route.\n credentials = r[\"credentials\"].get(urlparse(r[\"endpoint\"]).netloc, {})\n try:\n c = client.Client(r[\"endpoint\"], debug=r[\"debug\"],\n timeout=r[\"timeout\"], credentials)\n # This should rarely happen but better safe than sorry.\n except FDSNException as e: # pragma: no cover\n msg = e.args[0]\n msg += \"It will not be used for routing. Try again later?\"\n warnings.warn(msg)\n return None\n\n if not credentials and \"EIDA_TOKEN\" in r[\"credentials\"] and \\\n c._has_eida_auth:\n c.set_eida_token(r[\"credentials\"][\"EIDA_TOKEN\"])\n\n if r[\"data_type\"] == \"waveform\":\n fct = c.get_waveforms_bulk\n service = c.services[\"dataselect\"]\n elif r[\"data_type\"] == \"station\":\n fct = c.get_stations_bulk\n service = c.services[\"station\"]\n\n # Keep only kwargs that are supported by this particular service.\n kwargs = {k: v for k, v in r[\"kwargs\"].items() if k in service}\n bulk_str = \"\"\n for key, value in kwargs.items():\n bulk_str += \"%s=%s\\n\" % (key, str(value))\n try:\n return fct(bulk_str + r[\"bulk_str\"])\n except FDSNException:\n return None\n\n\ndef _strip_protocol(url):\n url = urlparse(url)\n return url.netloc + url.path\n\n\n# Does not inherit from the FDSN client as that would be fairly hacky as\n# some methods just make no sense for the routing client to have (e.g.\n# get_events() but also others).\nclass BaseRoutingClient(HTTPClient):\n def __init__(self, debug=False, timeout=120, include_providers=None,\n exclude_providers=None, credentials=None):\n \"\"\"\n :type routing_type: str\n :param routing_type: The type of\n router to initialize. For details see :func:`RoutingClient`.\n :type exclude_providers: str or list of str\n :param exclude_providers: Get no data from these providers. Can be\n the full HTTP address or one of the shortcuts ObsPy knows about.\n :type include_providers: str or list of str\n :param include_providers: Get data only from these providers. Can be\n the full HTTP address of one of the shortcuts ObsPy knows about.\n :type credentials: dict\n :param credentials: Credentials for the individual data centers as a\n dictionary that maps base url of FDSN web service to either\n username/password or EIDA token, e.g.\n ``credentials={\n 'geofon.gfz-potsdam.de': {'eida_token': 'my_token_file.txt'},\n 'service.iris.edu': {'user': 'me', 'password': 'my_pass'}\n 'EIDA_TOKEN': '/path/to/token.txt'\n }``\n The root level ``'EIDA_TOKEN'`` will be applied to all data centers\n that claim to support the ``/auth`` route and don't have data\n center specific credentials.\n You can also use a URL mapping as for the normal FDSN client\n instead of the URL.\n \"\"\"\n HTTPClient.__init__(self, debug=debug, timeout=timeout)\n self.include_providers = include_providers\n self.exclude_providers = exclude_providers\n\n # Parse credentials.\n self.credentials = {}\n for key, value in (credentials or {}).items():\n if key == \"EIDA_TOKEN\":\n self.credentials[key] = value\n # Map, if necessary.\n if key in URL_MAPPINGS:\n key = URL_MAPPINGS[key]\n # Make sure urlparse works correctly.\n if not key.startswith(\"http\"):\n key = \"http://\" + key\n # Only use the location.\n self.credentials[urlparse(key).netloc] = value\n\n @property\n def include_providers(self):\n return self.__include_providers\n\n @include_providers.setter\n def include_providers(self, value):\n self.__include_providers = self._expand_providers(value)\n\n @property\n def exclude_providers(self):\n return self.__exclude_providers\n\n @exclude_providers.setter\n def exclude_providers(self, value):\n self.__exclude_providers = self._expand_providers(value)\n\n def _expand_providers(self, providers):\n if providers is None:\n providers = []\n elif isinstance(providers, string_types):\n providers = [providers]\n return [_strip_protocol(URL_MAPPINGS[_i])\n if _i in URL_MAPPINGS\n else _strip_protocol(_i) for _i in providers]\n\n def _filter_requests(self, split):\n \"\"\"\n Filter requests based on including and excluding providers.\n\n :type split: dict\n :param split: A dictionary containing the desired routing.\n \"\"\"\n key_map = {_strip_protocol(url): url for url in split.keys()}\n\n # Apply both filters.\n f_keys = set(key_map.keys())\n if self.include_providers:\n f_keys = f_keys.intersection(set(self.include_providers))\n f_keys = f_keys.difference(set(self.exclude_providers))\n\n return {key_map[k]: split[key_map[k]] for k in f_keys}\n\n def _download_waveforms(self, split, kwargs):\n return self._download_parallel(split, data_type=\"waveform\", kwargs)\n\n def _download_stations(self, split, kwargs):\n return self._download_parallel(split, data_type=\"station\", kwargs)\n\n def _download_parallel(self, split, data_type, kwargs):\n # Apply the provider filter.\n split = self._filter_requests(split)\n\n if not split:\n raise FDSNNoDataException(\n \"Nothing remains to download after the provider \"\n \"inclusion/exclusion filters have been applied.\")\n\n if data_type not in [\"waveform\", \"station\"]: # pragma: no cover\n raise ValueError(\"Invalid data type.\")\n\n # One thread per data center.\n dl_requests = []\n for k, v in split.items():\n dl_requests.append({\n \"debug\": self._debug,\n \"timeout\": self._timeout,\n \"endpoint\": k,\n \"bulk_str\": v,\n \"data_type\": data_type,\n \"kwargs\": kwargs,\n \"credentials\": self.credentials})\n pool = ThreadPool(processes=len(dl_requests))\n results = pool.map(_try_download_bulk, dl_requests)\n\n # Merge all results into a single object.\n if data_type == \"waveform\":\n collection = obspy.Stream()\n elif data_type == \"station\":\n collection = obspy.Inventory(\n networks=[],\n source=\"ObsPy FDSN Routing %s\" % obspy.__version__)\n else: # pragma: no cover\n raise ValueError\n\n for _i in results:\n if not _i:\n continue\n collection += _i\n\n # Explitly close the thread pool as somehow this does not work\n # automatically under linux. See #2342.\n pool.close()\n\n return collection\n\n def _handle_requests_http_error(self, r):\n \"\"\"\n This assumes the same error code semantics as the base fdsnws web\n services.\n\n Please overwrite this method in a child class if necessary.\n \"\"\"\n reason = get_reason_from_response(r)\n if hasattr(r, \"content\"):\n c = r.content\n try:\n c = c.encode()\n except Exception:\n pass\n reason += b\" -- \" + c\n with io.BytesIO(reason) as buf:\n raise_on_error(r.status_code, buf)\n\n @_assert_filename_not_in_kwargs\n @_assert_attach_response_not_in_kwargs\n def get_waveforms(self, starttime, endtime, kwargs):\n \"\"\"\n Get waveforms from multiple data centers.\n\n Arguments are the same as in\n :meth:`obspy.clients.fdsn.client.Client.get_waveforms()`.\n Any additional ``kwargs`` are passed on to each individual service's\n dataselect service if the service supports them (otherwise they are\n silently ignored for that particular fdsnws endpoint).\n\n The ``filename`` and ``attach_response`` parameters of the single\n provider FDSN client are not supported.\n\n This can route on a number of different parameters, depending on the\n service, please see the web site of each individual routing service\n for details.\n \"\"\"\n # This just calls the bulk downloader to only implement the logic once.\n # Just pass these to the bulk request.\n bulk = []\n for _i in [\"network\", \"station\", \"location\", \"channel\"]:\n if _i in kwargs:\n bulk.append(kwargs[_i])\n del kwargs[_i]\n else:\n bulk.append(\"\")\n bulk.extend([starttime, endtime])\n return self.get_waveforms_bulk([bulk], kwargs)\n\n def get_service_version(self):\n \"\"\"\n Return a semantic version number of the remote service as a string.\n \"\"\"\n r = self._download(self._url + \"/version\")\n return r.content.decode() if \\\n hasattr(r.content, \"decode\") else r.content\n\n @_assert_filename_not_in_kwargs\n def get_stations(self, kwargs):\n \"\"\"\n Get stations from multiple data centers.\n\n It will pass on most parameters to the underlying routed service.\n They will also be passed on to the individual FDSNWS implementations\n if a service supports them.\n\n The ``filename`` parameter of the single provider FDSN client is not\n supported.\n\n This can route on a number of different parameters, please see the\n web sites of the\n `IRIS Federator <https://service.iris.edu/irisws/fedcatalog/1/>`_\n and of the `EIDAWS Routing Service\n <http://www.orfeus-eu.org/data/eida/webservices/routing/>`_ for\n details.\n \"\"\"\n # Just pass these to the bulk request.\n bulk = [kwargs.pop(key, '') for key in (\n \"network\", \"station\", \"location\", \"channel\", \"starttime\",\n \"endtime\")]\n return self.get_stations_bulk([bulk], **kwargs)\n\n\nif __name__ == '__main__': # pragma: no cover\n import doctest\n doctest.testmod(exclude_empty=True)\n", "path": "obspy/clients/fdsn/routing/routing_client.py" } ]	diff --git a/CHANGELOG.txt b/CHANGELOG.txt index b1b49484664..5abcccdd144 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -37,6 +37,8 @@ master: * make sure that streams fetched via FDSN are properly trimmed to user requested times if data center serves additional data around the start/end (see #1887, #2298) + * fix a problem that could spam subprocesses that were not closed in routed + clients (see #2342 and #2344) - obspy.io.nordic: * Add ability to read and write focal mechanisms and moment tensor information. (see #1924) diff --git a/obspy/clients/fdsn/routing/routing_client.py b/obspy/clients/fdsn/routing/routing_client.py index c0055cf5cf8..3b1a66e38e6 100644 --- a/obspy/clients/fdsn/routing/routing_client.py +++ b/obspy/clients/fdsn/routing/routing_client.py @@ -282,6 +282,10 @@ def _download_parallel(self, split, data_type, **kwargs): continue collection += _i + # Explitly close the thread pool as somehow this does not work + # automatically under linux. See #2342. + pool.close() + return collection def _handle_requests_http_error(self, r):
ckan__ckan-6057	Activity queries getting slow (~15 seconds) when following entities. ## CKAN version Tested in 2.9.2 but probably also happening in master ## Describe the bug `<lib/helpers.py:2567(new_activities)>` spikes to ~15 seconds if the user is following 2 or 3 organizations (with around 200 datasets each) in a ~1000+ dataset system. This makes the system unusable since this helper is called in almost every request to the UI. Without following organizations (50 ms): Calls \| Total Time (ms) \| Per Call (ms) \| Cumulative Time (ms) \| Per Call (ms) \| Function -- \| -- \| -- \| -- \| -- \| -- 1 \| 0.005 \| 0.0050 \| 52.439 \| 52.4390 \| <lib/helpers.py:2567(new_activities)> 1 \| 0.006 \| 0.0060 \| 52.374 \| 52.3740 \| <logic/action/get.py:3216(dashboard_new_activities_count)> 1 \| 0.016 \| 0.0160 \| 50.164 \| 50.1640 \| <ckanext/gdx/logic/action.py:418(dashboard_activity_list)> Following 3 organizations with 100 datasets each (1500 ms): Calls \| Total Time (ms) \| Per Call (ms) \| Cumulative Time (ms) \| Per Call (ms) \| Function -- \| -- \| -- \| -- \| -- \| -- 1 \| 0.01 \| 0.0100 \| 1610.417 \| 1610.4170 \| <lib/helpers.py:2567(new_activities)> 1 \| 0.018 \| 0.0180 \| 1610.26 \| 1610.2600 \| <logic/action/get.py:3216(dashboard_new_activities_count)> 1 \| 0.031 \| 0.0310 \| 1605.896 \| 1605.8960 \| <ckanext/gdx/logic/action.py:418(dashboard_activity_list)> ## Steps to reproduce Steps to reproduce the behavior: - Create 3 organizations - Add ~100 datasets to each one (enough to test) - Login with a user - Open the home page - Using flask debug toolbar's profiler measure the response time of the activity related methods: `<lib/helpers.py:2567(new_activities)>` - It should be around `50 ms` - Now follow the 3 organizations - Refresh the web page - The call to `<lib/helpers.py:2567(new_activities)>` it's now in 1500 ms (it will scale to ~20 seconds with a bigger database) ## Expected behavior The response time of the new activities feature will not impact on the UX of the site. (A delay time of ~100 ms?) ## Additional details The issue seems to be related to two main factors: 1. How the overall logic to get the new activities count is being made 2. How the internal queries to the activity models are being made 1. New Activities logic: The logic queries everything from the database and then uses some business logic in the action layer to filter results. Even when this approach may be fine in most cases, it is creating a bottleneck in the database for this feature. Example: Even when activities from the users [are not counted](https://github.com/ckan/ckan/blob/abfda8b401ec370c9c74fc67678dcb38f8c72a26/ckan/logic/action/get.py#L3235), it [queries them](https://github.com/ckan/ckan/blob/abfda8b401ec370c9c74fc67678dcb38f8c72a26/ckan/model/activity.py#L413) from the database, and then adds some logic to the returned dictionary to [filter the count](https://github.com/ckan/ckan/blob/abfda8b401ec370c9c74fc67678dcb38f8c72a26/ckan/logic/action/get.py#L3218). 2. Internal queries The logic to get activities from the database is a little bit complicated and not optimized. For each type of entity it: - Get every followee object (user following X object) - Creates and executes a select query for each of the previous objects - Creates a union of all the previous queries https://github.com/ckan/ckan/blob/abfda8b401ec370c9c74fc67678dcb38f8c72a26/ckan/model/activity.py#L346-L358 I played a little bit with queries. Instead of doing a union of select results, if I do a select filtering by id and the time of the query is reduced to a half (although It's not enough to reduce the time for a good UX). ```python def _activities_from_datasets_followed_by_user_query(user_id, limit): '''Return a query for all activities from datasets that user_id follows.''' import ckan.model as model # Get a list of the datasets that the user is following. follower_objects = model.UserFollowingDataset.followee_list(user_id) if not follower_objects: # Return a query with no results. return model.Session.query(model.Activity).filter(text('0=1')) packages_id = set([f.object_id for f in follower_objects]) return model.Session.query(model.Activity).\ filter(model.Activity.object_id.in_(packages_id)).\ limit(limit) ```	[ { "content": "# encoding: utf-8\n\nimport datetime\n\nfrom sqlalchemy import (\n orm,\n types,\n Column,\n Table,\n ForeignKey,\n desc,\n or_,\n and_,\n union_all,\n text,\n)\n\nfrom ckan.common import config\nimport ckan.model\nfrom ckan.model import meta\nfrom ckan.model import domain_object, types as _types\n\n__all__ = ['Activity', 'activity_table',\n 'ActivityDetail', 'activity_detail_table',\n ]\n\nactivity_table = Table(\n 'activity', meta.metadata,\n Column('id', types.UnicodeText, primary_key=True, default=_types.make_uuid),\n Column('timestamp', types.DateTime),\n Column('user_id', types.UnicodeText),\n Column('object_id', types.UnicodeText),\n # legacy revision_id values are used by migrate_package_activity.py\n Column('revision_id', types.UnicodeText),\n Column('activity_type', types.UnicodeText),\n Column('data', _types.JsonDictType),\n )\n\nactivity_detail_table = Table(\n 'activity_detail', meta.metadata,\n Column('id', types.UnicodeText, primary_key=True, default=_types.make_uuid),\n Column('activity_id', types.UnicodeText, ForeignKey('activity.id')),\n Column('object_id', types.UnicodeText),\n Column('object_type', types.UnicodeText),\n Column('activity_type', types.UnicodeText),\n Column('data', _types.JsonDictType),\n )\n\n\nclass Activity(domain_object.DomainObject):\n\n def __init__(\n self, user_id, object_id, activity_type, data=None):\n self.id = _types.make_uuid()\n self.timestamp = datetime.datetime.utcnow()\n self.user_id = user_id\n self.object_id = object_id\n self.activity_type = activity_type\n if data is None:\n self.data = {}\n else:\n self.data = data\n\n @classmethod\n def get(cls, id):\n '''Returns an Activity object referenced by its id.'''\n if not id:\n return None\n\n return meta.Session.query(cls).get(id)\n\n\nmeta.mapper(Activity, activity_table)\n\n\n# deprecated\nclass ActivityDetail(domain_object.DomainObject):\n\n def __init__(\n self, activity_id, object_id, object_type, activity_type,\n data=None):\n self.activity_id = activity_id\n self.object_id = object_id\n self.object_type = object_type\n self.activity_type = activity_type\n if data is None:\n self.data = {}\n else:\n self.data = data\n\n @classmethod\n def by_activity_id(cls, activity_id):\n return ckan.model.Session.query(cls) \\\n .filter_by(activity_id=activity_id).all()\n\n\nmeta.mapper(ActivityDetail, activity_detail_table, properties={\n 'activity': orm.relation(Activity, backref=orm.backref('activity_detail'))\n })\n\n\ndef _activities_limit(q, limit, offset=None):\n '''\n Return an SQLAlchemy query for all activities at an offset with a limit.\n '''\n import ckan.model as model\n q = q.order_by(desc(model.Activity.timestamp))\n if offset:\n q = q.offset(offset)\n if limit:\n q = q.limit(limit)\n return q\n\n\ndef _activities_union_all(qlist):\n '''\n Return union of two or more activity queries sorted by timestamp,\n and remove duplicates\n '''\n import ckan.model as model\n return model.Session.query(model.Activity).select_entity_from(\n union_all([q.subquery().select() for q in qlist])\n ).distinct(model.Activity.timestamp)\n\n\ndef _activities_at_offset(q, limit, offset):\n '''\n Return a list of all activities at an offset with a limit.\n '''\n return _activities_limit(q, limit, offset).all()\n\n\ndef _activities_from_user_query(user_id):\n '''Return an SQLAlchemy query for all activities from user_id.'''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.user_id == user_id)\n return q\n\n\ndef _activities_about_user_query(user_id):\n '''Return an SQLAlchemy query for all activities about user_id.'''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.object_id == user_id)\n return q\n\n\ndef _user_activity_query(user_id, limit):\n '''Return an SQLAlchemy query for all activities from or about user_id.'''\n q1 = _activities_limit(_activities_from_user_query(user_id), limit)\n q2 = _activities_limit(_activities_about_user_query(user_id), limit)\n return _activities_union_all(q1, q2)\n\n\ndef user_activity_list(user_id, limit, offset):\n '''Return user_id's public activity stream.\n\n Return a list of all activities from or about the given user, i.e. where\n the given user is the subject or object of the activity, e.g.:\n\n \"{USER} created the dataset {DATASET}\"\n \"{OTHER_USER} started following {USER}\"\n etc.\n\n '''\n q = _user_activity_query(user_id, limit + offset)\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _package_activity_query(package_id):\n '''Return an SQLAlchemy query for all activities about package_id.\n\n '''\n import ckan.model as model\n q = model.Session.query(model.Activity) \\\n .filter_by(object_id=package_id)\n return q\n\n\ndef package_activity_list(\n package_id, limit, offset, include_hidden_activity=False):\n '''Return the given dataset (package)'s public activity stream.\n\n Returns all activities about the given dataset, i.e. where the given\n dataset is the object of the activity, e.g.:\n\n \"{USER} created the dataset {DATASET}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _package_activity_query(package_id)\n\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _group_activity_query(group_id, include_hidden_activity=False):\n '''Return an SQLAlchemy query for all activities about group_id.\n\n Returns a query for all activities whose object is either the group itself\n or one of the group's datasets.\n\n '''\n import ckan.model as model\n\n group = model.Group.get(group_id)\n if not group:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n q = model.Session.query(\n model.Activity\n ).outerjoin(\n model.Member,\n and_(\n model.Activity.object_id == model.Member.table_id,\n )\n ).outerjoin(\n model.Package,\n and_(\n or_(model.Package.id == model.Member.table_id,\n model.Package.owner_org == group_id),\n model.Package.private == False,\n )\n ).filter(\n # We only care about activity either on the group itself or on packages\n # within that group.\n # FIXME: This means that activity that occured while a package belonged\n # to a group but was then removed will not show up. This may not be\n # desired but is consistent with legacy behaviour.\n or_(\n # active dataset in the group\n and_(model.Member.group_id == group_id,\n model.Member.state == 'active',\n model.Package.state == 'active'),\n # deleted dataset in the group\n and_(model.Member.group_id == group_id,\n model.Member.state == 'deleted',\n model.Package.state == 'deleted'),\n # (we want to avoid showing changes to an active dataset that\n # was once in this group)\n # activity the the group itself\n model.Activity.object_id == group_id,\n )\n )\n\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return q\n\n\ndef _organization_activity_query(org_id, include_hidden_activity=False):\n '''Return an SQLAlchemy query for all activities about org_id.\n\n Returns a query for all activities whose object is either the org itself\n or one of the org's datasets.\n\n '''\n import ckan.model as model\n\n org = model.Group.get(org_id)\n if not org or not org.is_organization:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n q = model.Session.query(\n model.Activity\n ).outerjoin(\n model.Package,\n and_(\n model.Package.id == model.Activity.object_id,\n model.Package.private == False,\n )\n ).filter(\n # We only care about activity either on the the org itself or on\n # packages within that org.\n # FIXME: This means that activity that occured while a package belonged\n # to a org but was then removed will not show up. This may not be\n # desired but is consistent with legacy behaviour.\n or_(\n model.Package.owner_org == org_id,\n model.Activity.object_id == org_id\n )\n )\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return q\n\n\ndef group_activity_list(group_id, limit, offset, include_hidden_activity=False):\n\n '''Return the given group's public activity stream.\n\n Returns activities where the given group or one of its datasets is the\n object of the activity, e.g.:\n\n \"{USER} updated the group {GROUP}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _group_activity_query(group_id, include_hidden_activity)\n return _activities_at_offset(q, limit, offset)\n\n\ndef organization_activity_list(\n group_id, limit, offset, include_hidden_activity=False):\n '''Return the given org's public activity stream.\n\n Returns activities where the given org or one of its datasets is the\n object of the activity, e.g.:\n\n \"{USER} updated the organization {ORG}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _organization_activity_query(group_id, include_hidden_activity)\n return _activities_at_offset(q, limit, offset)\n\n\ndef _activities_from_users_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from users that user_id follows.'''\n import ckan.model as model\n\n # Get a list of the users that the given user is following.\n follower_objects = model.UserFollowingUser.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _user_activity_query(follower.object_id, limit)\n for follower in follower_objects])\n\n\ndef _activities_from_datasets_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from datasets that user_id follows.'''\n import ckan.model as model\n\n # Get a list of the datasets that the user is following.\n follower_objects = model.UserFollowingDataset.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _activities_limit(_package_activity_query(follower.object_id), limit)\n for follower in follower_objects])\n\n\ndef _activities_from_groups_followed_by_user_query(user_id, limit):\n '''Return a query for all activities about groups the given user follows.\n\n Return a query for all activities about the groups the given user follows,\n or about any of the group's datasets. This is the union of\n _group_activity_query(group_id) for each of the groups the user follows.\n\n '''\n import ckan.model as model\n\n # Get a list of the group's that the user is following.\n follower_objects = model.UserFollowingGroup.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _activities_limit(_group_activity_query(follower.object_id), limit)\n for follower in follower_objects])\n\n\ndef _activities_from_everything_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from everything user_id follows.'''\n q1 = _activities_from_users_followed_by_user_query(user_id, limit)\n q2 = _activities_from_datasets_followed_by_user_query(user_id, limit)\n q3 = _activities_from_groups_followed_by_user_query(user_id, limit)\n return _activities_union_all(q1, q2, q3)\n\n\ndef activities_from_everything_followed_by_user(user_id, limit, offset):\n '''Return activities from everything that the given user is following.\n\n Returns all activities where the object of the activity is anything\n (user, dataset, group...) that the given user is following.\n\n '''\n q = _activities_from_everything_followed_by_user_query(\n user_id,\n limit + offset)\n return _activities_at_offset(q, limit, offset)\n\n\ndef _dashboard_activity_query(user_id, limit):\n '''Return an SQLAlchemy query for user_id's dashboard activity stream.'''\n q1 = _user_activity_query(user_id, limit)\n q2 = _activities_from_everything_followed_by_user_query(user_id, limit)\n return _activities_union_all(q1, q2)\n\n\ndef dashboard_activity_list(user_id, limit, offset):\n '''Return the given user's dashboard activity stream.\n\n Returns activities from the user's public activity stream, plus\n activities from everything that the user is following.\n\n This is the union of user_activity_list(user_id) and\n activities_from_everything_followed_by_user(user_id).\n\n '''\n q = _dashboard_activity_query(user_id, limit + offset)\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _changed_packages_activity_query():\n '''Return an SQLAlchemy query for all changed package activities.\n\n Return a query for all activities with activity_type 'package', e.g.\n 'new_package', 'changed_package', 'deleted_package'.\n\n '''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.activity_type.endswith('package'))\n return q\n\n\ndef recently_changed_packages_activity_list(limit, offset):\n '''Return the site-wide stream of recently changed package activities.\n\n This activity stream includes recent 'new package', 'changed package' and\n 'deleted package' activities for the whole site.\n\n '''\n q = _changed_packages_activity_query()\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _filter_activitites_from_users(q):\n '''\n Adds a filter to an existing query object ot avoid activities from users\n defined in :ref:`ckan.hide_activity_from_users` (defaults to the site user)\n '''\n users_to_avoid = _activity_stream_get_filtered_users()\n if users_to_avoid:\n q = q.filter(ckan.model.Activity.user_id.notin_(users_to_avoid))\n\n return q\n\n\ndef _activity_stream_get_filtered_users():\n '''\n Get the list of users from the :ref:`ckan.hide_activity_from_users` config\n option and return a list of their ids. If the config is not specified,\n returns the id of the site user.\n '''\n users = config.get('ckan.hide_activity_from_users')\n if users:\n users_list = users.split()\n else:\n from ckan.logic import get_action\n context = {'ignore_auth': True}\n site_user = get_action('get_site_user')(context)\n users_list = [site_user.get('name')]\n\n return ckan.model.User.user_ids_for_name_or_id(users_list)\n", "path": "ckan/model/activity.py" } ]	[ { "content": "# encoding: utf-8\n\nimport datetime\n\nfrom sqlalchemy import (\n orm,\n types,\n Column,\n Table,\n ForeignKey,\n desc,\n or_,\n and_,\n union_all,\n text,\n)\n\nfrom ckan.common import config\nimport ckan.model\nfrom ckan.model import meta\nfrom ckan.model import domain_object, types as _types\n\n__all__ = ['Activity', 'activity_table',\n 'ActivityDetail', 'activity_detail_table',\n ]\n\nactivity_table = Table(\n 'activity', meta.metadata,\n Column('id', types.UnicodeText, primary_key=True, default=_types.make_uuid),\n Column('timestamp', types.DateTime),\n Column('user_id', types.UnicodeText),\n Column('object_id', types.UnicodeText),\n # legacy revision_id values are used by migrate_package_activity.py\n Column('revision_id', types.UnicodeText),\n Column('activity_type', types.UnicodeText),\n Column('data', _types.JsonDictType),\n )\n\nactivity_detail_table = Table(\n 'activity_detail', meta.metadata,\n Column('id', types.UnicodeText, primary_key=True, default=_types.make_uuid),\n Column('activity_id', types.UnicodeText, ForeignKey('activity.id')),\n Column('object_id', types.UnicodeText),\n Column('object_type', types.UnicodeText),\n Column('activity_type', types.UnicodeText),\n Column('data', _types.JsonDictType),\n )\n\n\nclass Activity(domain_object.DomainObject):\n\n def __init__(\n self, user_id, object_id, activity_type, data=None):\n self.id = _types.make_uuid()\n self.timestamp = datetime.datetime.utcnow()\n self.user_id = user_id\n self.object_id = object_id\n self.activity_type = activity_type\n if data is None:\n self.data = {}\n else:\n self.data = data\n\n @classmethod\n def get(cls, id):\n '''Returns an Activity object referenced by its id.'''\n if not id:\n return None\n\n return meta.Session.query(cls).get(id)\n\n\nmeta.mapper(Activity, activity_table)\n\n\n# deprecated\nclass ActivityDetail(domain_object.DomainObject):\n\n def __init__(\n self, activity_id, object_id, object_type, activity_type,\n data=None):\n self.activity_id = activity_id\n self.object_id = object_id\n self.object_type = object_type\n self.activity_type = activity_type\n if data is None:\n self.data = {}\n else:\n self.data = data\n\n @classmethod\n def by_activity_id(cls, activity_id):\n return ckan.model.Session.query(cls) \\\n .filter_by(activity_id=activity_id).all()\n\n\nmeta.mapper(ActivityDetail, activity_detail_table, properties={\n 'activity': orm.relation(Activity, backref=orm.backref('activity_detail'))\n })\n\n\ndef _activities_limit(q, limit, offset=None):\n '''\n Return an SQLAlchemy query for all activities at an offset with a limit.\n '''\n import ckan.model as model\n q = q.order_by(desc(model.Activity.timestamp))\n if offset:\n q = q.offset(offset)\n if limit:\n q = q.limit(limit)\n return q\n\n\ndef _activities_union_all(qlist):\n '''\n Return union of two or more activity queries sorted by timestamp,\n and remove duplicates\n '''\n import ckan.model as model\n return model.Session.query(model.Activity).select_entity_from(\n union_all([q.subquery().select() for q in qlist])\n ).distinct(model.Activity.timestamp)\n\n\ndef _activities_at_offset(q, limit, offset):\n '''\n Return a list of all activities at an offset with a limit.\n '''\n return _activities_limit(q, limit, offset).all()\n\n\ndef _activities_from_user_query(user_id):\n '''Return an SQLAlchemy query for all activities from user_id.'''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.user_id == user_id)\n return q\n\n\ndef _activities_about_user_query(user_id):\n '''Return an SQLAlchemy query for all activities about user_id.'''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.object_id == user_id)\n return q\n\n\ndef _user_activity_query(user_id, limit):\n '''Return an SQLAlchemy query for all activities from or about user_id.'''\n q1 = _activities_limit(_activities_from_user_query(user_id), limit)\n q2 = _activities_limit(_activities_about_user_query(user_id), limit)\n return _activities_union_all(q1, q2)\n\n\ndef user_activity_list(user_id, limit, offset):\n '''Return user_id's public activity stream.\n\n Return a list of all activities from or about the given user, i.e. where\n the given user is the subject or object of the activity, e.g.:\n\n \"{USER} created the dataset {DATASET}\"\n \"{OTHER_USER} started following {USER}\"\n etc.\n\n '''\n q = _user_activity_query(user_id, limit + offset)\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _package_activity_query(package_id):\n '''Return an SQLAlchemy query for all activities about package_id.\n\n '''\n import ckan.model as model\n q = model.Session.query(model.Activity) \\\n .filter_by(object_id=package_id)\n return q\n\n\ndef package_activity_list(\n package_id, limit, offset, include_hidden_activity=False):\n '''Return the given dataset (package)'s public activity stream.\n\n Returns all activities about the given dataset, i.e. where the given\n dataset is the object of the activity, e.g.:\n\n \"{USER} created the dataset {DATASET}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _package_activity_query(package_id)\n\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _group_activity_query(group_id, include_hidden_activity=False):\n '''Return an SQLAlchemy query for all activities about group_id.\n\n Returns a query for all activities whose object is either the group itself\n or one of the group's datasets.\n\n '''\n import ckan.model as model\n\n group = model.Group.get(group_id)\n if not group:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n q = model.Session.query(\n model.Activity\n ).outerjoin(\n model.Member,\n and_(\n model.Activity.object_id == model.Member.table_id,\n )\n ).outerjoin(\n model.Package,\n and_(\n model.Package.id == model.Member.table_id,\n model.Package.private == False,\n )\n ).filter(\n # We only care about activity either on the group itself or on packages\n # within that group.\n # FIXME: This means that activity that occured while a package belonged\n # to a group but was then removed will not show up. This may not be\n # desired but is consistent with legacy behaviour.\n or_(\n # active dataset in the group\n and_(model.Member.group_id == group_id,\n model.Member.state == 'active',\n model.Package.state == 'active'),\n # deleted dataset in the group\n and_(model.Member.group_id == group_id,\n model.Member.state == 'deleted',\n model.Package.state == 'deleted'),\n # (we want to avoid showing changes to an active dataset that\n # was once in this group)\n # activity the the group itself\n model.Activity.object_id == group_id,\n )\n )\n\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return q\n\n\ndef _organization_activity_query(org_id, include_hidden_activity=False):\n '''Return an SQLAlchemy query for all activities about org_id.\n\n Returns a query for all activities whose object is either the org itself\n or one of the org's datasets.\n\n '''\n import ckan.model as model\n\n org = model.Group.get(org_id)\n if not org or not org.is_organization:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n q = model.Session.query(\n model.Activity\n ).outerjoin(\n model.Package,\n and_(\n model.Package.id == model.Activity.object_id,\n model.Package.private == False,\n )\n ).filter(\n # We only care about activity either on the the org itself or on\n # packages within that org.\n # FIXME: This means that activity that occured while a package belonged\n # to a org but was then removed will not show up. This may not be\n # desired but is consistent with legacy behaviour.\n or_(\n model.Package.owner_org == org_id,\n model.Activity.object_id == org_id\n )\n )\n if not include_hidden_activity:\n q = _filter_activitites_from_users(q)\n\n return q\n\n\ndef group_activity_list(group_id, limit, offset, include_hidden_activity=False):\n\n '''Return the given group's public activity stream.\n\n Returns activities where the given group or one of its datasets is the\n object of the activity, e.g.:\n\n \"{USER} updated the group {GROUP}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _group_activity_query(group_id, include_hidden_activity)\n return _activities_at_offset(q, limit, offset)\n\n\ndef organization_activity_list(\n group_id, limit, offset, include_hidden_activity=False):\n '''Return the given org's public activity stream.\n\n Returns activities where the given org or one of its datasets is the\n object of the activity, e.g.:\n\n \"{USER} updated the organization {ORG}\"\n \"{USER} updated the dataset {DATASET}\"\n etc.\n\n '''\n q = _organization_activity_query(group_id, include_hidden_activity)\n return _activities_at_offset(q, limit, offset)\n\n\ndef _activities_from_users_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from users that user_id follows.'''\n import ckan.model as model\n\n # Get a list of the users that the given user is following.\n follower_objects = model.UserFollowingUser.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _user_activity_query(follower.object_id, limit)\n for follower in follower_objects])\n\n\ndef _activities_from_datasets_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from datasets that user_id follows.'''\n import ckan.model as model\n\n # Get a list of the datasets that the user is following.\n follower_objects = model.UserFollowingDataset.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _activities_limit(_package_activity_query(follower.object_id), limit)\n for follower in follower_objects])\n\n\ndef _activities_from_groups_followed_by_user_query(user_id, limit):\n '''Return a query for all activities about groups the given user follows.\n\n Return a query for all activities about the groups the given user follows,\n or about any of the group's datasets. This is the union of\n _group_activity_query(group_id) for each of the groups the user follows.\n\n '''\n import ckan.model as model\n\n # Get a list of the group's that the user is following.\n follower_objects = model.UserFollowingGroup.followee_list(user_id)\n if not follower_objects:\n # Return a query with no results.\n return model.Session.query(model.Activity).filter(text('0=1'))\n\n return _activities_union_all([\n _activities_limit(_group_activity_query(follower.object_id), limit)\n for follower in follower_objects])\n\n\ndef _activities_from_everything_followed_by_user_query(user_id, limit):\n '''Return a query for all activities from everything user_id follows.'''\n q1 = _activities_from_users_followed_by_user_query(user_id, limit)\n q2 = _activities_from_datasets_followed_by_user_query(user_id, limit)\n q3 = _activities_from_groups_followed_by_user_query(user_id, limit)\n return _activities_union_all(q1, q2, q3)\n\n\ndef activities_from_everything_followed_by_user(user_id, limit, offset):\n '''Return activities from everything that the given user is following.\n\n Returns all activities where the object of the activity is anything\n (user, dataset, group...) that the given user is following.\n\n '''\n q = _activities_from_everything_followed_by_user_query(\n user_id,\n limit + offset)\n return _activities_at_offset(q, limit, offset)\n\n\ndef _dashboard_activity_query(user_id, limit):\n '''Return an SQLAlchemy query for user_id's dashboard activity stream.'''\n q1 = _user_activity_query(user_id, limit)\n q2 = _activities_from_everything_followed_by_user_query(user_id, limit)\n return _activities_union_all(q1, q2)\n\n\ndef dashboard_activity_list(user_id, limit, offset):\n '''Return the given user's dashboard activity stream.\n\n Returns activities from the user's public activity stream, plus\n activities from everything that the user is following.\n\n This is the union of user_activity_list(user_id) and\n activities_from_everything_followed_by_user(user_id).\n\n '''\n q = _dashboard_activity_query(user_id, limit + offset)\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _changed_packages_activity_query():\n '''Return an SQLAlchemy query for all changed package activities.\n\n Return a query for all activities with activity_type 'package', e.g.\n 'new_package', 'changed_package', 'deleted_package'.\n\n '''\n import ckan.model as model\n q = model.Session.query(model.Activity)\n q = q.filter(model.Activity.activity_type.endswith('package'))\n return q\n\n\ndef recently_changed_packages_activity_list(limit, offset):\n '''Return the site-wide stream of recently changed package activities.\n\n This activity stream includes recent 'new package', 'changed package' and\n 'deleted package' activities for the whole site.\n\n '''\n q = _changed_packages_activity_query()\n\n q = _filter_activitites_from_users(q)\n\n return _activities_at_offset(q, limit, offset)\n\n\ndef _filter_activitites_from_users(q):\n '''\n Adds a filter to an existing query object ot avoid activities from users\n defined in :ref:`ckan.hide_activity_from_users` (defaults to the site user)\n '''\n users_to_avoid = _activity_stream_get_filtered_users()\n if users_to_avoid:\n q = q.filter(ckan.model.Activity.user_id.notin_(users_to_avoid))\n\n return q\n\n\ndef _activity_stream_get_filtered_users():\n '''\n Get the list of users from the :ref:`ckan.hide_activity_from_users` config\n option and return a list of their ids. If the config is not specified,\n returns the id of the site user.\n '''\n users = config.get('ckan.hide_activity_from_users')\n if users:\n users_list = users.split()\n else:\n from ckan.logic import get_action\n context = {'ignore_auth': True}\n site_user = get_action('get_site_user')(context)\n users_list = [site_user.get('name')]\n\n return ckan.model.User.user_ids_for_name_or_id(users_list)\n", "path": "ckan/model/activity.py" } ]	diff --git a/changes/6028.bugfix b/changes/6028.bugfix new file mode 100644 index 00000000000..2bbd9faf175 --- /dev/null +++ b/changes/6028.bugfix @@ -0,0 +1 @@ +Fix performance bottleneck in activity queries diff --git a/ckan/model/activity.py b/ckan/model/activity.py index a1cada55c90..12ac4b9c631 100644 --- a/ckan/model/activity.py +++ b/ckan/model/activity.py @@ -225,8 +225,7 @@ def _group_activity_query(group_id, include_hidden_activity=False): ).outerjoin( model.Package, and_( - or_(model.Package.id == model.Member.table_id, - model.Package.owner_org == group_id), + model.Package.id == model.Member.table_id, model.Package.private == False, ) ).filter( diff --git a/ckan/tests/logic/action/test_get.py b/ckan/tests/logic/action/test_get.py index 6df19f23297..0c67015f222 100644 --- a/ckan/tests/logic/action/test_get.py +++ b/ckan/tests/logic/action/test_get.py @@ -4338,14 +4338,44 @@ def test_activities_on_a_dataset_in_a_followed_group(self): user = factories.User() another_user = factories.Sysadmin() group = factories.Group(user=user) + helpers.call_action( + "follow_group", context={"user": user["name"]}, group + ) _clear_activities() dataset = factories.Dataset( groups=[{"name": group["name"]}], user=another_user ) dataset["title"] = "Dataset with changed title" helpers.call_action( - "follow_dataset", context={"user": user["name"]}, dataset + "package_update", context={"user": another_user["name"]}, dataset ) + + activities = helpers.call_action( + "dashboard_activity_list", context={"user": user["id"]} + ) + assert [ + (activity["activity_type"], activity["is_new"]) + for activity in activities[::-1] + ] == [("new package", True), ("changed package", True)] + assert ( + helpers.call_action( + "dashboard_new_activities_count", context={"user": user["id"]} + ) + == 2 + ) + + def test_activities_on_a_dataset_in_a_followed_org(self): + user = factories.User() + another_user = factories.Sysadmin() + org = factories.Organization(user=user) + helpers.call_action( + "follow_group", context={"user": user["name"]}, org + ) + _clear_activities() + dataset = factories.Dataset( + owner_org=org['id'], user=another_user + ) + dataset["title"] = "Dataset with changed title" helpers.call_action( "package_update", context={"user": another_user["name"]}, **dataset )
obspy__obspy-2204	Cartopy local projection for south hemisphere. Hi, There is a misbehavior on the local projection option on the South hemisphere using cartopy: Test code as follow: ``` import matplotlib.pyplot as plt import obspy from obspy.clients.fdsn import Client auspass = Client("http://auspass.edu.au:8080") station = auspass.get_stations(network='',station='',starttime=obspy.UTCDateTime('1950-01-01'),endtime=obspy.UTCDateTime()) station.plot(projection='local', color_per_network=True) ``` The fix is the following: In obspy/imaging/maps.py (line 618 -- 620) ``` proj_kwargs['central_latitude'] = lat_0 proj_kwargs['central_longitude'] = lon_0 proj_kwargs['standard_parallels'] = [lat_0,lat_0] #Line to add to have the same behavior than Basemap proj = ccrs.AlbersEqualArea(*proj_kwargs) ``` Thanks Sebastien Cartopy local projection for south hemisphere. Hi, There is a misbehavior on the local projection option on the South hemisphere using cartopy: Test code as follow: ``` import matplotlib.pyplot as plt import obspy from obspy.clients.fdsn import Client auspass = Client("http://auspass.edu.au:8080") station = auspass.get_stations(network='',station='',starttime=obspy.UTCDateTime('1950-01-01'),endtime=obspy.UTCDateTime()) station.plot(projection='local', color_per_network=True) ``` The fix is the following:* In obspy/imaging/maps.py (line 618 -- 620) ``` proj_kwargs['central_latitude'] = lat_0 proj_kwargs['central_longitude'] = lon_0 proj_kwargs['standard_parallels'] = [lat_0,lat_0] #Line to add to have the same behavior than Basemap proj = ccrs.AlbersEqualArea(**proj_kwargs) ``` Thanks Sebastien	[ { "content": "# -- coding: utf-8 --\n\"\"\"\nModule for basemap related plotting in ObsPy.\n\n:copyright:\n The ObsPy Development Team ([email protected])\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_import, division, print_function,\n unicode_literals)\nfrom future.builtins import * # NOQA @UnusedWildImport\nfrom future.utils import native_str\n\nimport datetime\nimport warnings\n\nimport numpy as np\nfrom matplotlib.colorbar import Colorbar\nfrom matplotlib.dates import AutoDateFormatter, AutoDateLocator, date2num\nimport matplotlib.patheffects as PathEffects\nfrom matplotlib.ticker import (FormatStrFormatter, Formatter, FuncFormatter,\n MaxNLocator)\n\nfrom obspy import UTCDateTime\nfrom obspy.core.util import (BASEMAP_VERSION, CARTOPY_VERSION,\n MATPLOTLIB_VERSION)\nfrom obspy.geodetics.base import mean_longitude\n\n\nif BASEMAP_VERSION:\n from mpl_toolkits.basemap import Basemap\n HAS_BASEMAP = True\n if BASEMAP_VERSION < [1, 0, 4]:\n warnings.warn(\"All basemap version < 1.0.4 contain a serious bug \"\n \"when rendering countries and continents. ObsPy will \"\n \"still work but the maps might be wrong. Please update \"\n \"your basemap installation.\")\nelse:\n HAS_BASEMAP = False\n\nif CARTOPY_VERSION and CARTOPY_VERSION >= [0, 12, 0]:\n import cartopy.crs as ccrs\n import cartopy.feature as cfeature\n HAS_CARTOPY = True\nelse:\n HAS_CARTOPY = False\n\n\nif not HAS_BASEMAP and not HAS_CARTOPY:\n msg = (\"Neither basemap nor cartopy installed, map plots will not work.\")\n warnings.warn(msg)\n\n\n_BASEMAP_RESOLUTIONS = {\n '110m': 'l',\n '50m': 'i',\n '10m': 'f',\n 'c': 'c',\n 'l': 'l',\n 'i': 'i',\n 'h': 'h',\n 'f': 'f',\n}\n\n_CARTOPY_RESOLUTIONS = {\n 'c': '110m',\n 'l': '110m',\n 'i': '50m',\n 'h': '50m',\n 'f': '10m',\n '110m': '110m',\n '50m': '50m',\n '10m': '10m',\n}\n\nif HAS_CARTOPY:\n _CARTOPY_FEATURES = {\n '110m': (cfeature.BORDERS, cfeature.LAND, cfeature.OCEAN),\n }\n\n\ndef plot_basemap(lons, lats, size, color, labels=None, projection='global',\n resolution='l', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, colorbar=None,\n marker=\"o\", title=None, colorbar_ticklabel_format=None,\n show=True, fig=None, *kwargs): # @UnusedVariable\n \"\"\"\n Creates a basemap plot with a data point scatter plot.\n\n :type lons: list/tuple of floats\n :param lons: Longitudes of the data points.\n :type lats: list/tuple of floats\n :param lats: Latitudes of the data points.\n :type size: float or list/tuple of floats\n :param size: Size of the individual points in the scatter plot.\n :type color: list/tuple of floats (or objects that can be\n converted to floats, like e.g.\n :class:`~obspy.core.utcdatetime.UTCDateTime`)\n :param color: Color information of the individual data points to be\n used in the specified color map (e.g. origin depths,\n origin times).\n :type labels: list/tuple of str\n :param labels: Annotations for the individual data points.\n :type projection: str, optional\n :param projection: The map projection.\n Currently supported are:\n\n ``\"global\"`` (Will plot the whole world.)\n * ``\"ortho\"`` (Will center around the mean lat/long.)\n * ``\"local\"`` (Will plot around local events)\n\n Defaults to \"global\".\n :type resolution: str, optional\n :param resolution: Resolution of the boundary database to use. Will be\n based directly to the basemap module. Possible values are:\n\n * ``\"c\"`` (crude)\n * ``\"l\"`` (low)\n * ``\"i\"`` (intermediate)\n * ``\"h\"`` (high)\n * ``\"f\"`` (full)\n\n Defaults to ``\"l\"``. For compatibility, you may also specify any of the\n Cartopy resolutions defined in :func:`plot_cartopy`.\n :type continent_fill_color: Valid matplotlib color, optional\n :param continent_fill_color: Color of the continents. Defaults to\n ``\"0.9\"`` which is a light gray.\n :type water_fill_color: Valid matplotlib color, optional\n :param water_fill_color: Color of all water bodies.\n Defaults to ``\"white\"``.\n :type colormap: str, any matplotlib colormap, optional\n :param colormap: The colormap for color-coding the events as provided\n in `color` kwarg.\n The event with the smallest `color` property will have the\n color of one end of the colormap and the event with the highest\n `color` property the color of the other end with all other events\n in between.\n Defaults to None which will use the default matplotlib colormap.\n :type colorbar: bool, optional\n :param colorbar: When left `None`, a colorbar is plotted if more than one\n object is plotted. Using `True`/`False` the colorbar can be forced\n on/off.\n :type title: str\n :param title: Title above plot.\n :type colorbar_ticklabel_format: str or function or\n subclass of :class:`matplotlib.ticker.Formatter`\n :param colorbar_ticklabel_format: Format string or Formatter used to format\n colorbar tick labels.\n :type show: bool\n :param show: Whether to show the figure after plotting or not. Can be used\n to do further customization of the plot before showing it.\n :type fig: :class:`matplotlib.figure.Figure`\n :param fig: Figure instance to reuse, returned from a previous\n :func:`plot_basemap` call. If a previous basemap plot is reused, any\n kwargs regarding the basemap plot setup will be ignored (i.e.\n `projection`, `resolution`, `continent_fill_color`,\n `water_fill_color`). Note that multiple plots using colorbars likely\n are problematic, but e.g. one station plot (without colorbar) and one\n event plot (with colorbar) together should work well.\n \"\"\"\n import matplotlib.pyplot as plt\n\n if any([isinstance(c, (datetime.datetime, UTCDateTime)) for c in color]):\n datetimeplot = True\n color = [\n (np.isfinite(float(t)) and\n date2num(getattr(t, 'datetime', t)) or\n np.nan)\n for t in color]\n else:\n datetimeplot = False\n\n # The colorbar should only be plotted if more then one event is\n # present.\n if colorbar is None:\n if len(lons) > 1 and hasattr(color, \"__len__\") and \\\n not isinstance(color, (str, native_str)):\n colorbar = True\n else:\n colorbar = False\n\n if fig is None:\n fig = plt.figure()\n\n if projection == \"local\":\n ax_x0, ax_width = 0.10, 0.80\n elif projection == \"global\":\n ax_x0, ax_width = 0.01, 0.98\n else:\n ax_x0, ax_width = 0.05, 0.90\n\n if colorbar:\n map_ax = fig.add_axes([ax_x0, 0.13, ax_width, 0.77])\n cm_ax = fig.add_axes([ax_x0, 0.05, ax_width, 0.05])\n else:\n ax_y0, ax_height = 0.05, 0.85\n if projection == \"local\":\n ax_y0 += 0.05\n ax_height -= 0.05\n map_ax = fig.add_axes([ax_x0, ax_y0, ax_width, ax_height])\n bmap = None\n\n else:\n error_message_suffix = (\n \". Please provide a figure object from a previous call to the \"\n \".plot() method of e.g. an Inventory or Catalog object.\")\n try:\n map_ax = fig.axes[0]\n except IndexError as e:\n e.args = tuple([e.args[0] + error_message_suffix] +\n list(e.args[1:]))\n raise\n try:\n bmap = fig.bmap\n except AttributeError as e:\n e.args = tuple([e.args[0] + error_message_suffix] +\n list(e.args[1:]))\n raise\n\n # basemap plots will break with basemap 1.1.0 together with matplotlib\n # >=2.3 (see matplotlib/basemap#382) so only thing we can do is show a\n # nicer message.\n # XXX can be removed maybe a year or so after basemap\n # 1.1.1 or 1.2.0 is released\n try:\n from matplotlib.cbook import MatplotlibDeprecationWarning\n except ImportError:\n # matplotlib 1.2.0 does not have that warning class yet\n # XXX can be removed when minimum matplotlib version gets bumped to\n # XXX 1.3.0\n category = {}\n else:\n category = {'category': MatplotlibDeprecationWarning}\n try:\n with warnings.catch_warnings():\n warnings.filterwarnings(\n 'ignore', message='The axesPatch function was deprecated '\n 'in version 2.1. Use Axes.patch instead.',\n module='.basemap.', category)\n scatter = _plot_basemap_into_axes(\n ax=map_ax, lons=lons, lats=lats, size=size, color=color,\n bmap=bmap, labels=labels, projection=projection,\n resolution=resolution,\n continent_fill_color=continent_fill_color,\n water_fill_color=water_fill_color, colormap=colormap,\n marker=marker, title=\"\", adjust_aspect_to_colorbar=colorbar,\n kwargs)\n except AttributeError as e:\n if 'axesPatch' not in str(e):\n raise\n msg = ('Encountered a problem doing the basemap plot due to a known '\n 'issue of matplotlib >=2.3 together with basemap <=1.1.0 (see '\n 'https://github.com/matplotlib/basemap/issues/382). Please '\n 'update basemap to a version >1.1.0 if available or downgrade '\n 'matplotlib to a version <2.3.')\n raise Exception(msg)\n\n if title:\n plt.suptitle(title)\n\n if colorbar:\n if colorbar_ticklabel_format is not None:\n if isinstance(colorbar_ticklabel_format, (str, native_str)):\n formatter = FormatStrFormatter(colorbar_ticklabel_format)\n elif hasattr(colorbar_ticklabel_format, '__call__'):\n formatter = FuncFormatter(colorbar_ticklabel_format)\n elif isinstance(colorbar_ticklabel_format, Formatter):\n formatter = colorbar_ticklabel_format\n locator = MaxNLocator(5)\n else:\n if datetimeplot:\n locator = AutoDateLocator()\n formatter = AutoDateFormatter(locator)\n # Compat with old matplotlib versions.\n if hasattr(formatter, \"scaled\"):\n formatter.scaled[1 / (24. * 60.)] = '%H:%M:%S'\n else:\n locator = None\n formatter = None\n\n # normal case: axes for colorbar was set up in this routine\n if \"cm_ax\" in locals():\n cb_kwargs = {\"cax\": cm_ax}\n # unusual case: reusing a plot that has no colorbar set up previously\n else:\n cb_kwargs = {\"ax\": map_ax}\n\n cb = fig.colorbar(\n mappable=scatter, cmap=colormap, orientation='horizontal',\n ticks=locator, format=formatter, cb_kwargs)\n # Compat with old matplotlib versions.\n if hasattr(cb, \"update_ticks\"):\n cb.update_ticks()\n\n if show:\n plt.show()\n\n return fig\n\n\ndef _plot_basemap_into_axes(\n ax, lons, lats, size, color, bmap=None, labels=None,\n projection='global', resolution='l', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, marker=\"o\", title=None,\n adjust_aspect_to_colorbar=False, kwargs): # @UnusedVariable\n \"\"\"\n Creates a (or adds to existing) basemap plot with a data point scatter\n plot in given axes.\n\n See :func:`plot_basemap` for details on most args/kwargs.\n\n :type ax: :class:`matplotlib.axes.Axes`\n :param ax: Existing matplotlib axes instance, optionally with previous\n basemap plot (see `bmap` kwarg).\n :type bmap: :class:`mpl_toolkits.basemap.Basemap`\n :param bmap: Basemap instance in provided matplotlib Axes `ax` to reuse. If\n specified, any kwargs regarding the basemap plot setup will be ignored\n (i.e. `projection`, `resolution`, `continent_fill_color`,\n `water_fill_color`).\n :rtype: :class:`matplotlib.collections.PathCollection`\n :returns: Matplotlib path collection (e.g. to reuse for colorbars).\n \"\"\"\n fig = ax.figure\n if bmap is None:\n\n if projection == 'global':\n bmap = Basemap(projection='moll', lon_0=round(np.mean(lons), 4),\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n ax=ax)\n elif projection == 'ortho':\n bmap = Basemap(projection='ortho',\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n area_thresh=1000.0, lat_0=round(np.mean(lats), 4),\n lon_0=round(mean_longitude(lons), 4), ax=ax)\n elif projection == 'local':\n if min(lons) < -150 and max(lons) > 150:\n max_lons = max(np.array(lons) % 360)\n min_lons = min(np.array(lons) % 360)\n else:\n max_lons = max(lons)\n min_lons = min(lons)\n lat_0 = max(lats) / 2. + min(lats) / 2.\n lon_0 = max_lons / 2. + min_lons / 2.\n if lon_0 > 180:\n lon_0 -= 360\n deg2m_lat = 2 * np.pi * 6371 * 1000 / 360\n deg2m_lon = deg2m_lat * np.cos(lat_0 / 180 * np.pi)\n if len(lats) > 1:\n height = (max(lats) - min(lats)) * deg2m_lat\n width = (max_lons - min_lons) * deg2m_lon\n margin = 0.2 * (width + height)\n height += margin\n width += margin\n else:\n height = 2.0 * deg2m_lat\n width = 5.0 * deg2m_lon\n # do intelligent aspect calculation for local projection\n # adjust to figure dimensions\n w, h = fig.get_size_inches()\n ax_bbox = ax.get_position()\n aspect = (w * ax_bbox.width) / (h * ax_bbox.height)\n if adjust_aspect_to_colorbar:\n aspect = 1.2\n if width / height < aspect:\n width = height aspect\n else:\n height = width / aspect\n\n bmap = Basemap(projection='aea',\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n area_thresh=1000.0, lat_0=round(lat_0, 4),\n lon_0=round(lon_0, 4),\n width=width, height=height, ax=ax)\n # not most elegant way to calculate some round lats/lons\n\n def linspace2(val1, val2, n):\n \"\"\"\n returns around n 'nice' values between val1 and val2\n \"\"\"\n dval = val2 - val1\n round_pos = int(round(-np.log10(1. * dval / n)))\n # Fake negative rounding as not supported by future as of now.\n if round_pos < 0:\n factor = 10 ** (abs(round_pos))\n delta = round(2. * dval / n / factor) * factor / 2\n else:\n delta = round(2. * dval / n, round_pos) / 2\n new_val1 = np.ceil(val1 / delta) * delta\n new_val2 = np.floor(val2 / delta) * delta\n n = int((new_val2 - new_val1) / delta + 1)\n return np.linspace(new_val1, new_val2, n)\n\n n_1 = int(np.ceil(height / max(width, height) * 8))\n n_2 = int(np.ceil(width / max(width, height) * 8))\n parallels = linspace2(lat_0 - height / 2 / deg2m_lat,\n lat_0 + height / 2 / deg2m_lat, n_1)\n\n # Old basemap versions have problems with non-integer parallels.\n try:\n bmap.drawparallels(parallels, labels=[0, 1, 1, 0])\n except KeyError:\n parallels = sorted(list(set(map(int, parallels))))\n bmap.drawparallels(parallels, labels=[0, 1, 1, 0])\n\n if min(lons) < -150 and max(lons) > 150:\n lon_0 %= 360\n meridians = linspace2(lon_0 - width / 2 / deg2m_lon,\n lon_0 + width / 2 / deg2m_lon, n_2)\n meridians[meridians > 180] -= 360\n bmap.drawmeridians(meridians, labels=[1, 0, 0, 1])\n else:\n msg = \"Projection '%s' not supported.\" % projection\n raise ValueError(msg)\n\n # draw coast lines, country boundaries, fill continents.\n if MATPLOTLIB_VERSION >= [2, 0, 0]:\n ax.set_facecolor(water_fill_color)\n else:\n ax.set_axis_bgcolor(water_fill_color)\n bmap.drawcoastlines(color=\"0.4\")\n bmap.drawcountries(color=\"0.75\")\n bmap.fillcontinents(color=continent_fill_color,\n lake_color=water_fill_color)\n # draw the edge of the bmap projection region (the projection limb)\n bmap.drawmapboundary(fill_color=water_fill_color)\n # draw lat/lon grid lines every 30 degrees.\n bmap.drawmeridians(np.arange(-180, 180, 30))\n bmap.drawparallels(np.arange(-90, 90, 30))\n fig.bmap = bmap\n\n # compute the native bmap projection coordinates for events.\n x, y = bmap(lons, lats)\n # plot labels\n if labels:\n if 100 > len(lons) > 1:\n for name, xpt, ypt, _colorpt in zip(labels, x, y, color):\n # Check if the point can actually be seen with the current bmap\n # projection. The bmap object will set the coordinates to very\n # large values if it cannot project a point.\n if xpt > 1e25:\n continue\n ax.text(xpt, ypt, name, weight=\"heavy\",\n color=\"k\", zorder=100,\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n elif len(lons) == 1:\n ax.text(x[0], y[0], labels[0], weight=\"heavy\", color=\"k\",\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n\n # scatter plot is removing valid x/y points with invalid color value,\n # so we plot those points separately.\n try:\n nan_points = np.isnan(np.array(color, dtype=np.float))\n except ValueError:\n # `color' was not a list of values, but a list of colors.\n pass\n else:\n if nan_points.any():\n x_ = np.array(x)[nan_points]\n y_ = np.array(y)[nan_points]\n size_ = np.array(size)[nan_points]\n bmap.scatter(x_, y_, marker=marker, s=size_, c=\"0.3\",\n zorder=10, cmap=None)\n scatter = bmap.scatter(x, y, marker=marker, s=size, c=color, zorder=10,\n cmap=colormap)\n\n if title:\n ax.set_title(title)\n\n return scatter\n\n\ndef plot_cartopy(lons, lats, size, color, labels=None, projection='global',\n resolution='110m', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, colorbar=None,\n marker=\"o\", title=None, colorbar_ticklabel_format=None,\n show=True, proj_kwargs=None, *kwargs): # @UnusedVariable\n \"\"\"\n Creates a Cartopy plot with a data point scatter plot.\n\n :type lons: list/tuple of floats\n :param lons: Longitudes of the data points.\n :type lats: list/tuple of floats\n :param lats: Latitudes of the data points.\n :type size: float or list/tuple of floats\n :param size: Size of the individual points in the scatter plot.\n :type color: list/tuple of floats (or objects that can be\n converted to floats, like e.g.\n :class:`~obspy.core.utcdatetime.UTCDateTime`)\n :param color: Color information of the individual data points to be\n used in the specified color map (e.g. origin depths,\n origin times).\n :type labels: list/tuple of str\n :param labels: Annotations for the individual data points.\n :type projection: str, optional\n :param projection: The map projection.\n Currently supported are:\n\n ``\"global\"`` (Will plot the whole world using\n :class:`~cartopy.crs.Mollweide`.)\n * ``\"ortho\"`` (Will center around the mean lat/long using\n :class:`~cartopy.crs.Orthographic`.)\n * ``\"local\"`` (Will plot around local events using\n :class:`~cartopy.crs.AlbersEqualArea`.)\n * Any other Cartopy :class:`~cartopy.crs.Projection`. An instance\n of this class will be created using the supplied ``proj_kwargs``.\n\n Defaults to \"global\"\n :type resolution: str, optional\n :param resolution: Resolution of the boundary database to use. Will be\n passed directly to the Cartopy module. Possible values are:\n\n * ``\"110m\"``\n * ``\"50m\"``\n * ``\"10m\"``\n\n Defaults to ``\"110m\"``. For compatibility, you may also specify any of\n the Basemap resolutions defined in :func:`plot_basemap`.\n :type continent_fill_color: Valid matplotlib color, optional\n :param continent_fill_color: Color of the continents. Defaults to\n ``\"0.9\"`` which is a light gray.\n :type water_fill_color: Valid matplotlib color, optional\n :param water_fill_color: Color of all water bodies.\n Defaults to ``\"white\"``.\n :type colormap: str, any matplotlib colormap, optional\n :param colormap: The colormap for color-coding the events as provided\n in `color` kwarg.\n The event with the smallest `color` property will have the\n color of one end of the colormap and the event with the highest\n `color` property the color of the other end with all other events\n in between.\n Defaults to None which will use the default matplotlib colormap.\n :type colorbar: bool, optional\n :param colorbar: When left `None`, a colorbar is plotted if more than one\n object is plotted. Using `True`/`False` the colorbar can be forced\n on/off.\n :type title: str\n :param title: Title above plot.\n :type colorbar_ticklabel_format: str or function or\n subclass of :class:`matplotlib.ticker.Formatter`\n :param colorbar_ticklabel_format: Format string or Formatter used to format\n colorbar tick labels.\n :type show: bool\n :param show: Whether to show the figure after plotting or not. Can be used\n to do further customization of the plot before showing it.\n :type proj_kwargs: dict\n :param proj_kwargs: Keyword arguments to pass to the Cartopy\n :class:`~cartopy.ccrs.Projection`. In this dictionary, you may specify\n ``central_longitude='auto'`` or ``central_latitude='auto'`` to have\n this function calculate the latitude or longitude as it would for other\n projections. Some arguments may be ignored if you choose one of the\n built-in ``projection`` choices.\n \"\"\"\n import matplotlib.pyplot as plt\n\n if isinstance(color[0], (datetime.datetime, UTCDateTime)):\n datetimeplot = True\n color = [date2num(getattr(t, 'datetime', t)) for t in color]\n else:\n datetimeplot = False\n\n fig = plt.figure()\n\n # The colorbar should only be plotted if more then one event is\n # present.\n if colorbar is not None:\n show_colorbar = colorbar\n else:\n if len(lons) > 1 and hasattr(color, \"__len__\") and \\\n not isinstance(color, (str, native_str)):\n show_colorbar = True\n else:\n show_colorbar = False\n\n if projection == \"local\":\n ax_x0, ax_width = 0.10, 0.80\n elif projection == \"global\":\n ax_x0, ax_width = 0.01, 0.98\n else:\n ax_x0, ax_width = 0.05, 0.90\n\n proj_kwargs = proj_kwargs or {}\n if projection == 'global':\n proj_kwargs['central_longitude'] = np.mean(lons)\n proj = ccrs.Mollweide(proj_kwargs)\n elif projection == 'ortho':\n proj_kwargs['central_latitude'] = np.mean(lats)\n proj_kwargs['central_longitude'] = mean_longitude(lons)\n proj = ccrs.Orthographic(proj_kwargs)\n elif projection == 'local':\n if min(lons) < -150 and max(lons) > 150:\n max_lons = max(np.array(lons) % 360)\n min_lons = min(np.array(lons) % 360)\n else:\n max_lons = max(lons)\n min_lons = min(lons)\n lat_0 = max(lats) / 2. + min(lats) / 2.\n lon_0 = max_lons / 2. + min_lons / 2.\n if lon_0 > 180:\n lon_0 -= 360\n deg2m_lat = 2 * np.pi * 6371 * 1000 / 360\n deg2m_lon = deg2m_lat * np.cos(lat_0 / 180 * np.pi)\n if len(lats) > 1:\n height = (max(lats) - min(lats)) * deg2m_lat\n width = (max_lons - min_lons) * deg2m_lon\n margin = 0.2 * (width + height)\n height += margin\n width += margin\n else:\n height = 2.0 * deg2m_lat\n width = 5.0 * deg2m_lon\n # Do intelligent aspect calculation for local projection\n # adjust to figure dimensions\n w, h = fig.get_size_inches()\n aspect = w / h\n if show_colorbar:\n aspect = 1.2\n if width / height < aspect:\n width = height aspect\n else:\n height = width / aspect\n\n proj_kwargs['central_latitude'] = lat_0\n proj_kwargs['central_longitude'] = lon_0\n proj = ccrs.AlbersEqualArea(proj_kwargs)\n\n # User-supplied projection.\n elif isinstance(projection, type):\n if 'central_longitude' in proj_kwargs:\n if proj_kwargs['central_longitude'] == 'auto':\n proj_kwargs['central_longitude'] = mean_longitude(lons)\n if 'central_latitude' in proj_kwargs:\n if proj_kwargs['central_latitude'] == 'auto':\n proj_kwargs['central_latitude'] = np.mean(lats)\n if 'pole_longitude' in proj_kwargs:\n if proj_kwargs['pole_longitude'] == 'auto':\n proj_kwargs['pole_longitude'] = np.mean(lons)\n if 'pole_latitude' in proj_kwargs:\n if proj_kwargs['pole_latitude'] == 'auto':\n proj_kwargs['pole_latitude'] = np.mean(lats)\n\n proj = projection(proj_kwargs)\n\n else:\n msg = \"Projection '%s' not supported.\" % projection\n raise ValueError(msg)\n\n if show_colorbar:\n map_ax = fig.add_axes([ax_x0, 0.13, ax_width, 0.77], projection=proj)\n cm_ax = fig.add_axes([ax_x0, 0.05, ax_width, 0.05])\n plt.sca(map_ax)\n else:\n ax_y0, ax_height = 0.05, 0.85\n if projection == \"local\":\n ax_y0 += 0.05\n ax_height -= 0.05\n map_ax = fig.add_axes([ax_x0, ax_y0, ax_width, ax_height],\n projection=proj)\n\n if projection == 'local':\n x0, y0 = proj.transform_point(lon_0, lat_0, proj.as_geodetic())\n map_ax.set_xlim(x0 - width / 2, x0 + width / 2)\n map_ax.set_ylim(y0 - height / 2, y0 + height / 2)\n else:\n map_ax.set_global()\n\n # Pick features at specified resolution.\n resolution = _CARTOPY_RESOLUTIONS[resolution]\n try:\n borders, land, ocean = _CARTOPY_FEATURES[resolution]\n except KeyError:\n borders = cfeature.NaturalEarthFeature(cfeature.BORDERS.category,\n cfeature.BORDERS.name,\n resolution,\n edgecolor='none',\n facecolor='none')\n land = cfeature.NaturalEarthFeature(cfeature.LAND.category,\n cfeature.LAND.name, resolution,\n edgecolor='face', facecolor='none')\n ocean = cfeature.NaturalEarthFeature(cfeature.OCEAN.category,\n cfeature.OCEAN.name, resolution,\n edgecolor='face',\n facecolor='none')\n _CARTOPY_FEATURES[resolution] = (borders, land, ocean)\n\n # Draw coast lines, country boundaries, fill continents.\n if MATPLOTLIB_VERSION >= [2, 0, 0]:\n map_ax.set_facecolor(water_fill_color)\n else:\n map_ax.set_axis_bgcolor(water_fill_color)\n map_ax.add_feature(ocean, facecolor=water_fill_color)\n map_ax.add_feature(land, facecolor=continent_fill_color)\n map_ax.add_feature(borders, edgecolor='0.75')\n map_ax.coastlines(resolution=resolution, color='0.4')\n\n # Draw grid lines - TODO: draw_labels=True doesn't work yet.\n if projection == 'local':\n map_ax.gridlines()\n else:\n # Draw lat/lon grid lines every 30 degrees.\n map_ax.gridlines(xlocs=range(-180, 181, 30), ylocs=range(-90, 91, 30))\n\n # Plot labels\n if labels and len(lons) > 0:\n with map_ax.hold_limits():\n for name, xpt, ypt, _colorpt in zip(labels, lons, lats, color):\n map_ax.text(xpt, ypt, name, weight=\"heavy\", color=\"k\",\n zorder=100, transform=ccrs.Geodetic(),\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n\n scatter = map_ax.scatter(lons, lats, marker=marker, s=size, c=color,\n zorder=10, cmap=colormap,\n transform=ccrs.Geodetic())\n\n if title:\n plt.suptitle(title)\n\n # Only show the colorbar for more than one event.\n if show_colorbar:\n if colorbar_ticklabel_format is not None:\n if isinstance(colorbar_ticklabel_format, (str, native_str)):\n formatter = FormatStrFormatter(colorbar_ticklabel_format)\n elif hasattr(colorbar_ticklabel_format, '__call__'):\n formatter = FuncFormatter(colorbar_ticklabel_format)\n elif isinstance(colorbar_ticklabel_format, Formatter):\n formatter = colorbar_ticklabel_format\n locator = MaxNLocator(5)\n else:\n if datetimeplot:\n locator = AutoDateLocator()\n formatter = AutoDateFormatter(locator)\n # Compat with old matplotlib versions.\n if hasattr(formatter, \"scaled\"):\n formatter.scaled[1 / (24. * 60.)] = '%H:%M:%S'\n else:\n locator = None\n formatter = None\n cb = Colorbar(cm_ax, scatter, cmap=colormap,\n orientation='horizontal',\n ticks=locator,\n format=formatter)\n # Compat with old matplotlib versions.\n if hasattr(cb, \"update_ticks\"):\n cb.update_ticks()\n\n if show:\n plt.show()\n\n return fig\n\n\ndef plot_map(method, args, kwargs):\n '''\n Creates a map plot with a data point scatter plot.\n\n :type method: str\n :param method: Method to use for plotting. Possible values are:\n\n ``'basemap'`` to use the Basemap library. For other arguments, see\n the :func:`plot_basemap` function.\n * ``'cartopy'`` to use the Cartopy library. For other arguments, see\n the :func:`plot_cartopy` function.\n * ``None`` to use either the Basemap or Cartopy library, whichever is\n available.\n '''\n\n if method is None:\n if HAS_BASEMAP:\n return plot_basemap(args, kwargs)\n elif HAS_CARTOPY:\n return plot_cartopy(args, *kwargs)\n else:\n raise ImportError('Neither Basemap nor Cartopy could be imported.')\n elif method == 'basemap':\n if not HAS_BASEMAP:\n raise ImportError('Basemap cannot be imported but was explicitly '\n 'requested.')\n return plot_basemap(args, *kwargs)\n elif method == 'cartopy':\n if not HAS_CARTOPY:\n raise ImportError('Cartopy cannot be imported but was explicitly '\n 'requested.')\n return plot_cartopy(args, **kwargs)\n else:\n raise ValueError(\"The method argument must be either 'basemap' or \"\n \"'cartopy', not '%s'.\" % (method, ))\n", "path": "obspy/imaging/maps.py" } ]	[ { "content": "# -- coding: utf-8 --\n\"\"\"\nModule for basemap related plotting in ObsPy.\n\n:copyright:\n The ObsPy Development Team ([email protected])\n:license:\n GNU Lesser General Public License, Version 3\n (https://www.gnu.org/copyleft/lesser.html)\n\"\"\"\nfrom __future__ import (absolute_import, division, print_function,\n unicode_literals)\nfrom future.builtins import * # NOQA @UnusedWildImport\nfrom future.utils import native_str\n\nimport datetime\nimport warnings\n\nimport numpy as np\nfrom matplotlib.colorbar import Colorbar\nfrom matplotlib.dates import AutoDateFormatter, AutoDateLocator, date2num\nimport matplotlib.patheffects as PathEffects\nfrom matplotlib.ticker import (FormatStrFormatter, Formatter, FuncFormatter,\n MaxNLocator)\n\nfrom obspy import UTCDateTime\nfrom obspy.core.util import (BASEMAP_VERSION, CARTOPY_VERSION,\n MATPLOTLIB_VERSION)\nfrom obspy.geodetics.base import mean_longitude\n\n\nif BASEMAP_VERSION:\n from mpl_toolkits.basemap import Basemap\n HAS_BASEMAP = True\n if BASEMAP_VERSION < [1, 0, 4]:\n warnings.warn(\"All basemap version < 1.0.4 contain a serious bug \"\n \"when rendering countries and continents. ObsPy will \"\n \"still work but the maps might be wrong. Please update \"\n \"your basemap installation.\")\nelse:\n HAS_BASEMAP = False\n\nif CARTOPY_VERSION and CARTOPY_VERSION >= [0, 12, 0]:\n import cartopy.crs as ccrs\n import cartopy.feature as cfeature\n HAS_CARTOPY = True\nelse:\n HAS_CARTOPY = False\n\n\nif not HAS_BASEMAP and not HAS_CARTOPY:\n msg = (\"Neither basemap nor cartopy installed, map plots will not work.\")\n warnings.warn(msg)\n\n\n_BASEMAP_RESOLUTIONS = {\n '110m': 'l',\n '50m': 'i',\n '10m': 'f',\n 'c': 'c',\n 'l': 'l',\n 'i': 'i',\n 'h': 'h',\n 'f': 'f',\n}\n\n_CARTOPY_RESOLUTIONS = {\n 'c': '110m',\n 'l': '110m',\n 'i': '50m',\n 'h': '50m',\n 'f': '10m',\n '110m': '110m',\n '50m': '50m',\n '10m': '10m',\n}\n\nif HAS_CARTOPY:\n _CARTOPY_FEATURES = {\n '110m': (cfeature.BORDERS, cfeature.LAND, cfeature.OCEAN),\n }\n\n\ndef plot_basemap(lons, lats, size, color, labels=None, projection='global',\n resolution='l', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, colorbar=None,\n marker=\"o\", title=None, colorbar_ticklabel_format=None,\n show=True, fig=None, *kwargs): # @UnusedVariable\n \"\"\"\n Creates a basemap plot with a data point scatter plot.\n\n :type lons: list/tuple of floats\n :param lons: Longitudes of the data points.\n :type lats: list/tuple of floats\n :param lats: Latitudes of the data points.\n :type size: float or list/tuple of floats\n :param size: Size of the individual points in the scatter plot.\n :type color: list/tuple of floats (or objects that can be\n converted to floats, like e.g.\n :class:`~obspy.core.utcdatetime.UTCDateTime`)\n :param color: Color information of the individual data points to be\n used in the specified color map (e.g. origin depths,\n origin times).\n :type labels: list/tuple of str\n :param labels: Annotations for the individual data points.\n :type projection: str, optional\n :param projection: The map projection.\n Currently supported are:\n\n ``\"global\"`` (Will plot the whole world.)\n * ``\"ortho\"`` (Will center around the mean lat/long.)\n * ``\"local\"`` (Will plot around local events)\n\n Defaults to \"global\".\n :type resolution: str, optional\n :param resolution: Resolution of the boundary database to use. Will be\n based directly to the basemap module. Possible values are:\n\n * ``\"c\"`` (crude)\n * ``\"l\"`` (low)\n * ``\"i\"`` (intermediate)\n * ``\"h\"`` (high)\n * ``\"f\"`` (full)\n\n Defaults to ``\"l\"``. For compatibility, you may also specify any of the\n Cartopy resolutions defined in :func:`plot_cartopy`.\n :type continent_fill_color: Valid matplotlib color, optional\n :param continent_fill_color: Color of the continents. Defaults to\n ``\"0.9\"`` which is a light gray.\n :type water_fill_color: Valid matplotlib color, optional\n :param water_fill_color: Color of all water bodies.\n Defaults to ``\"white\"``.\n :type colormap: str, any matplotlib colormap, optional\n :param colormap: The colormap for color-coding the events as provided\n in `color` kwarg.\n The event with the smallest `color` property will have the\n color of one end of the colormap and the event with the highest\n `color` property the color of the other end with all other events\n in between.\n Defaults to None which will use the default matplotlib colormap.\n :type colorbar: bool, optional\n :param colorbar: When left `None`, a colorbar is plotted if more than one\n object is plotted. Using `True`/`False` the colorbar can be forced\n on/off.\n :type title: str\n :param title: Title above plot.\n :type colorbar_ticklabel_format: str or function or\n subclass of :class:`matplotlib.ticker.Formatter`\n :param colorbar_ticklabel_format: Format string or Formatter used to format\n colorbar tick labels.\n :type show: bool\n :param show: Whether to show the figure after plotting or not. Can be used\n to do further customization of the plot before showing it.\n :type fig: :class:`matplotlib.figure.Figure`\n :param fig: Figure instance to reuse, returned from a previous\n :func:`plot_basemap` call. If a previous basemap plot is reused, any\n kwargs regarding the basemap plot setup will be ignored (i.e.\n `projection`, `resolution`, `continent_fill_color`,\n `water_fill_color`). Note that multiple plots using colorbars likely\n are problematic, but e.g. one station plot (without colorbar) and one\n event plot (with colorbar) together should work well.\n \"\"\"\n import matplotlib.pyplot as plt\n\n if any([isinstance(c, (datetime.datetime, UTCDateTime)) for c in color]):\n datetimeplot = True\n color = [\n (np.isfinite(float(t)) and\n date2num(getattr(t, 'datetime', t)) or\n np.nan)\n for t in color]\n else:\n datetimeplot = False\n\n # The colorbar should only be plotted if more then one event is\n # present.\n if colorbar is None:\n if len(lons) > 1 and hasattr(color, \"__len__\") and \\\n not isinstance(color, (str, native_str)):\n colorbar = True\n else:\n colorbar = False\n\n if fig is None:\n fig = plt.figure()\n\n if projection == \"local\":\n ax_x0, ax_width = 0.10, 0.80\n elif projection == \"global\":\n ax_x0, ax_width = 0.01, 0.98\n else:\n ax_x0, ax_width = 0.05, 0.90\n\n if colorbar:\n map_ax = fig.add_axes([ax_x0, 0.13, ax_width, 0.77])\n cm_ax = fig.add_axes([ax_x0, 0.05, ax_width, 0.05])\n else:\n ax_y0, ax_height = 0.05, 0.85\n if projection == \"local\":\n ax_y0 += 0.05\n ax_height -= 0.05\n map_ax = fig.add_axes([ax_x0, ax_y0, ax_width, ax_height])\n bmap = None\n\n else:\n error_message_suffix = (\n \". Please provide a figure object from a previous call to the \"\n \".plot() method of e.g. an Inventory or Catalog object.\")\n try:\n map_ax = fig.axes[0]\n except IndexError as e:\n e.args = tuple([e.args[0] + error_message_suffix] +\n list(e.args[1:]))\n raise\n try:\n bmap = fig.bmap\n except AttributeError as e:\n e.args = tuple([e.args[0] + error_message_suffix] +\n list(e.args[1:]))\n raise\n\n # basemap plots will break with basemap 1.1.0 together with matplotlib\n # >=2.3 (see matplotlib/basemap#382) so only thing we can do is show a\n # nicer message.\n # XXX can be removed maybe a year or so after basemap\n # 1.1.1 or 1.2.0 is released\n try:\n from matplotlib.cbook import MatplotlibDeprecationWarning\n except ImportError:\n # matplotlib 1.2.0 does not have that warning class yet\n # XXX can be removed when minimum matplotlib version gets bumped to\n # XXX 1.3.0\n category = {}\n else:\n category = {'category': MatplotlibDeprecationWarning}\n try:\n with warnings.catch_warnings():\n warnings.filterwarnings(\n 'ignore', message='The axesPatch function was deprecated '\n 'in version 2.1. Use Axes.patch instead.',\n module='.basemap.', category)\n scatter = _plot_basemap_into_axes(\n ax=map_ax, lons=lons, lats=lats, size=size, color=color,\n bmap=bmap, labels=labels, projection=projection,\n resolution=resolution,\n continent_fill_color=continent_fill_color,\n water_fill_color=water_fill_color, colormap=colormap,\n marker=marker, title=\"\", adjust_aspect_to_colorbar=colorbar,\n kwargs)\n except AttributeError as e:\n if 'axesPatch' not in str(e):\n raise\n msg = ('Encountered a problem doing the basemap plot due to a known '\n 'issue of matplotlib >=2.3 together with basemap <=1.1.0 (see '\n 'https://github.com/matplotlib/basemap/issues/382). Please '\n 'update basemap to a version >1.1.0 if available or downgrade '\n 'matplotlib to a version <2.3.')\n raise Exception(msg)\n\n if title:\n plt.suptitle(title)\n\n if colorbar:\n if colorbar_ticklabel_format is not None:\n if isinstance(colorbar_ticklabel_format, (str, native_str)):\n formatter = FormatStrFormatter(colorbar_ticklabel_format)\n elif hasattr(colorbar_ticklabel_format, '__call__'):\n formatter = FuncFormatter(colorbar_ticklabel_format)\n elif isinstance(colorbar_ticklabel_format, Formatter):\n formatter = colorbar_ticklabel_format\n locator = MaxNLocator(5)\n else:\n if datetimeplot:\n locator = AutoDateLocator()\n formatter = AutoDateFormatter(locator)\n # Compat with old matplotlib versions.\n if hasattr(formatter, \"scaled\"):\n formatter.scaled[1 / (24. * 60.)] = '%H:%M:%S'\n else:\n locator = None\n formatter = None\n\n # normal case: axes for colorbar was set up in this routine\n if \"cm_ax\" in locals():\n cb_kwargs = {\"cax\": cm_ax}\n # unusual case: reusing a plot that has no colorbar set up previously\n else:\n cb_kwargs = {\"ax\": map_ax}\n\n cb = fig.colorbar(\n mappable=scatter, cmap=colormap, orientation='horizontal',\n ticks=locator, format=formatter, cb_kwargs)\n # Compat with old matplotlib versions.\n if hasattr(cb, \"update_ticks\"):\n cb.update_ticks()\n\n if show:\n plt.show()\n\n return fig\n\n\ndef _plot_basemap_into_axes(\n ax, lons, lats, size, color, bmap=None, labels=None,\n projection='global', resolution='l', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, marker=\"o\", title=None,\n adjust_aspect_to_colorbar=False, kwargs): # @UnusedVariable\n \"\"\"\n Creates a (or adds to existing) basemap plot with a data point scatter\n plot in given axes.\n\n See :func:`plot_basemap` for details on most args/kwargs.\n\n :type ax: :class:`matplotlib.axes.Axes`\n :param ax: Existing matplotlib axes instance, optionally with previous\n basemap plot (see `bmap` kwarg).\n :type bmap: :class:`mpl_toolkits.basemap.Basemap`\n :param bmap: Basemap instance in provided matplotlib Axes `ax` to reuse. If\n specified, any kwargs regarding the basemap plot setup will be ignored\n (i.e. `projection`, `resolution`, `continent_fill_color`,\n `water_fill_color`).\n :rtype: :class:`matplotlib.collections.PathCollection`\n :returns: Matplotlib path collection (e.g. to reuse for colorbars).\n \"\"\"\n fig = ax.figure\n if bmap is None:\n\n if projection == 'global':\n bmap = Basemap(projection='moll', lon_0=round(np.mean(lons), 4),\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n ax=ax)\n elif projection == 'ortho':\n bmap = Basemap(projection='ortho',\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n area_thresh=1000.0, lat_0=round(np.mean(lats), 4),\n lon_0=round(mean_longitude(lons), 4), ax=ax)\n elif projection == 'local':\n if min(lons) < -150 and max(lons) > 150:\n max_lons = max(np.array(lons) % 360)\n min_lons = min(np.array(lons) % 360)\n else:\n max_lons = max(lons)\n min_lons = min(lons)\n lat_0 = max(lats) / 2. + min(lats) / 2.\n lon_0 = max_lons / 2. + min_lons / 2.\n if lon_0 > 180:\n lon_0 -= 360\n deg2m_lat = 2 * np.pi * 6371 * 1000 / 360\n deg2m_lon = deg2m_lat * np.cos(lat_0 / 180 * np.pi)\n if len(lats) > 1:\n height = (max(lats) - min(lats)) * deg2m_lat\n width = (max_lons - min_lons) * deg2m_lon\n margin = 0.2 * (width + height)\n height += margin\n width += margin\n else:\n height = 2.0 * deg2m_lat\n width = 5.0 * deg2m_lon\n # do intelligent aspect calculation for local projection\n # adjust to figure dimensions\n w, h = fig.get_size_inches()\n ax_bbox = ax.get_position()\n aspect = (w * ax_bbox.width) / (h * ax_bbox.height)\n if adjust_aspect_to_colorbar:\n aspect = 1.2\n if width / height < aspect:\n width = height aspect\n else:\n height = width / aspect\n\n bmap = Basemap(projection='aea',\n resolution=_BASEMAP_RESOLUTIONS[resolution],\n area_thresh=1000.0, lat_0=round(lat_0, 4),\n lon_0=round(lon_0, 4),\n width=width, height=height, ax=ax)\n # not most elegant way to calculate some round lats/lons\n\n def linspace2(val1, val2, n):\n \"\"\"\n returns around n 'nice' values between val1 and val2\n \"\"\"\n dval = val2 - val1\n round_pos = int(round(-np.log10(1. * dval / n)))\n # Fake negative rounding as not supported by future as of now.\n if round_pos < 0:\n factor = 10 ** (abs(round_pos))\n delta = round(2. * dval / n / factor) * factor / 2\n else:\n delta = round(2. * dval / n, round_pos) / 2\n new_val1 = np.ceil(val1 / delta) * delta\n new_val2 = np.floor(val2 / delta) * delta\n n = int((new_val2 - new_val1) / delta + 1)\n return np.linspace(new_val1, new_val2, n)\n\n n_1 = int(np.ceil(height / max(width, height) * 8))\n n_2 = int(np.ceil(width / max(width, height) * 8))\n parallels = linspace2(lat_0 - height / 2 / deg2m_lat,\n lat_0 + height / 2 / deg2m_lat, n_1)\n\n # Old basemap versions have problems with non-integer parallels.\n try:\n bmap.drawparallels(parallels, labels=[0, 1, 1, 0])\n except KeyError:\n parallels = sorted(list(set(map(int, parallels))))\n bmap.drawparallels(parallels, labels=[0, 1, 1, 0])\n\n if min(lons) < -150 and max(lons) > 150:\n lon_0 %= 360\n meridians = linspace2(lon_0 - width / 2 / deg2m_lon,\n lon_0 + width / 2 / deg2m_lon, n_2)\n meridians[meridians > 180] -= 360\n bmap.drawmeridians(meridians, labels=[1, 0, 0, 1])\n else:\n msg = \"Projection '%s' not supported.\" % projection\n raise ValueError(msg)\n\n # draw coast lines, country boundaries, fill continents.\n if MATPLOTLIB_VERSION >= [2, 0, 0]:\n ax.set_facecolor(water_fill_color)\n else:\n ax.set_axis_bgcolor(water_fill_color)\n bmap.drawcoastlines(color=\"0.4\")\n bmap.drawcountries(color=\"0.75\")\n bmap.fillcontinents(color=continent_fill_color,\n lake_color=water_fill_color)\n # draw the edge of the bmap projection region (the projection limb)\n bmap.drawmapboundary(fill_color=water_fill_color)\n # draw lat/lon grid lines every 30 degrees.\n bmap.drawmeridians(np.arange(-180, 180, 30))\n bmap.drawparallels(np.arange(-90, 90, 30))\n fig.bmap = bmap\n\n # compute the native bmap projection coordinates for events.\n x, y = bmap(lons, lats)\n # plot labels\n if labels:\n if 100 > len(lons) > 1:\n for name, xpt, ypt, _colorpt in zip(labels, x, y, color):\n # Check if the point can actually be seen with the current bmap\n # projection. The bmap object will set the coordinates to very\n # large values if it cannot project a point.\n if xpt > 1e25:\n continue\n ax.text(xpt, ypt, name, weight=\"heavy\",\n color=\"k\", zorder=100,\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n elif len(lons) == 1:\n ax.text(x[0], y[0], labels[0], weight=\"heavy\", color=\"k\",\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n\n # scatter plot is removing valid x/y points with invalid color value,\n # so we plot those points separately.\n try:\n nan_points = np.isnan(np.array(color, dtype=np.float))\n except ValueError:\n # `color' was not a list of values, but a list of colors.\n pass\n else:\n if nan_points.any():\n x_ = np.array(x)[nan_points]\n y_ = np.array(y)[nan_points]\n size_ = np.array(size)[nan_points]\n bmap.scatter(x_, y_, marker=marker, s=size_, c=\"0.3\",\n zorder=10, cmap=None)\n scatter = bmap.scatter(x, y, marker=marker, s=size, c=color, zorder=10,\n cmap=colormap)\n\n if title:\n ax.set_title(title)\n\n return scatter\n\n\ndef plot_cartopy(lons, lats, size, color, labels=None, projection='global',\n resolution='110m', continent_fill_color='0.8',\n water_fill_color='1.0', colormap=None, colorbar=None,\n marker=\"o\", title=None, colorbar_ticklabel_format=None,\n show=True, proj_kwargs=None, *kwargs): # @UnusedVariable\n \"\"\"\n Creates a Cartopy plot with a data point scatter plot.\n\n :type lons: list/tuple of floats\n :param lons: Longitudes of the data points.\n :type lats: list/tuple of floats\n :param lats: Latitudes of the data points.\n :type size: float or list/tuple of floats\n :param size: Size of the individual points in the scatter plot.\n :type color: list/tuple of floats (or objects that can be\n converted to floats, like e.g.\n :class:`~obspy.core.utcdatetime.UTCDateTime`)\n :param color: Color information of the individual data points to be\n used in the specified color map (e.g. origin depths,\n origin times).\n :type labels: list/tuple of str\n :param labels: Annotations for the individual data points.\n :type projection: str, optional\n :param projection: The map projection.\n Currently supported are:\n\n ``\"global\"`` (Will plot the whole world using\n :class:`~cartopy.crs.Mollweide`.)\n * ``\"ortho\"`` (Will center around the mean lat/long using\n :class:`~cartopy.crs.Orthographic`.)\n * ``\"local\"`` (Will plot around local events using\n :class:`~cartopy.crs.AlbersEqualArea`.)\n * Any other Cartopy :class:`~cartopy.crs.Projection`. An instance\n of this class will be created using the supplied ``proj_kwargs``.\n\n Defaults to \"global\"\n :type resolution: str, optional\n :param resolution: Resolution of the boundary database to use. Will be\n passed directly to the Cartopy module. Possible values are:\n\n * ``\"110m\"``\n * ``\"50m\"``\n * ``\"10m\"``\n\n Defaults to ``\"110m\"``. For compatibility, you may also specify any of\n the Basemap resolutions defined in :func:`plot_basemap`.\n :type continent_fill_color: Valid matplotlib color, optional\n :param continent_fill_color: Color of the continents. Defaults to\n ``\"0.9\"`` which is a light gray.\n :type water_fill_color: Valid matplotlib color, optional\n :param water_fill_color: Color of all water bodies.\n Defaults to ``\"white\"``.\n :type colormap: str, any matplotlib colormap, optional\n :param colormap: The colormap for color-coding the events as provided\n in `color` kwarg.\n The event with the smallest `color` property will have the\n color of one end of the colormap and the event with the highest\n `color` property the color of the other end with all other events\n in between.\n Defaults to None which will use the default matplotlib colormap.\n :type colorbar: bool, optional\n :param colorbar: When left `None`, a colorbar is plotted if more than one\n object is plotted. Using `True`/`False` the colorbar can be forced\n on/off.\n :type title: str\n :param title: Title above plot.\n :type colorbar_ticklabel_format: str or function or\n subclass of :class:`matplotlib.ticker.Formatter`\n :param colorbar_ticklabel_format: Format string or Formatter used to format\n colorbar tick labels.\n :type show: bool\n :param show: Whether to show the figure after plotting or not. Can be used\n to do further customization of the plot before showing it.\n :type proj_kwargs: dict\n :param proj_kwargs: Keyword arguments to pass to the Cartopy\n :class:`~cartopy.ccrs.Projection`. In this dictionary, you may specify\n ``central_longitude='auto'`` or ``central_latitude='auto'`` to have\n this function calculate the latitude or longitude as it would for other\n projections. Some arguments may be ignored if you choose one of the\n built-in ``projection`` choices.\n \"\"\"\n import matplotlib.pyplot as plt\n\n if isinstance(color[0], (datetime.datetime, UTCDateTime)):\n datetimeplot = True\n color = [date2num(getattr(t, 'datetime', t)) for t in color]\n else:\n datetimeplot = False\n\n fig = plt.figure()\n\n # The colorbar should only be plotted if more then one event is\n # present.\n if colorbar is not None:\n show_colorbar = colorbar\n else:\n if len(lons) > 1 and hasattr(color, \"__len__\") and \\\n not isinstance(color, (str, native_str)):\n show_colorbar = True\n else:\n show_colorbar = False\n\n if projection == \"local\":\n ax_x0, ax_width = 0.10, 0.80\n elif projection == \"global\":\n ax_x0, ax_width = 0.01, 0.98\n else:\n ax_x0, ax_width = 0.05, 0.90\n\n proj_kwargs = proj_kwargs or {}\n if projection == 'global':\n proj_kwargs['central_longitude'] = np.mean(lons)\n proj = ccrs.Mollweide(proj_kwargs)\n elif projection == 'ortho':\n proj_kwargs['central_latitude'] = np.mean(lats)\n proj_kwargs['central_longitude'] = mean_longitude(lons)\n proj = ccrs.Orthographic(proj_kwargs)\n elif projection == 'local':\n if min(lons) < -150 and max(lons) > 150:\n max_lons = max(np.array(lons) % 360)\n min_lons = min(np.array(lons) % 360)\n else:\n max_lons = max(lons)\n min_lons = min(lons)\n lat_0 = max(lats) / 2. + min(lats) / 2.\n lon_0 = max_lons / 2. + min_lons / 2.\n if lon_0 > 180:\n lon_0 -= 360\n deg2m_lat = 2 * np.pi * 6371 * 1000 / 360\n deg2m_lon = deg2m_lat * np.cos(lat_0 / 180 * np.pi)\n if len(lats) > 1:\n height = (max(lats) - min(lats)) * deg2m_lat\n width = (max_lons - min_lons) * deg2m_lon\n margin = 0.2 * (width + height)\n height += margin\n width += margin\n else:\n height = 2.0 * deg2m_lat\n width = 5.0 * deg2m_lon\n # Do intelligent aspect calculation for local projection\n # adjust to figure dimensions\n w, h = fig.get_size_inches()\n aspect = w / h\n if show_colorbar:\n aspect = 1.2\n if width / height < aspect:\n width = height aspect\n else:\n height = width / aspect\n\n proj_kwargs['central_latitude'] = lat_0\n proj_kwargs['central_longitude'] = lon_0\n proj_kwargs['standard_parallels'] = [lat_0, lat_0]\n proj = ccrs.AlbersEqualArea(proj_kwargs)\n\n # User-supplied projection.\n elif isinstance(projection, type):\n if 'central_longitude' in proj_kwargs:\n if proj_kwargs['central_longitude'] == 'auto':\n proj_kwargs['central_longitude'] = mean_longitude(lons)\n if 'central_latitude' in proj_kwargs:\n if proj_kwargs['central_latitude'] == 'auto':\n proj_kwargs['central_latitude'] = np.mean(lats)\n if 'pole_longitude' in proj_kwargs:\n if proj_kwargs['pole_longitude'] == 'auto':\n proj_kwargs['pole_longitude'] = np.mean(lons)\n if 'pole_latitude' in proj_kwargs:\n if proj_kwargs['pole_latitude'] == 'auto':\n proj_kwargs['pole_latitude'] = np.mean(lats)\n\n proj = projection(proj_kwargs)\n\n else:\n msg = \"Projection '%s' not supported.\" % projection\n raise ValueError(msg)\n\n if show_colorbar:\n map_ax = fig.add_axes([ax_x0, 0.13, ax_width, 0.77], projection=proj)\n cm_ax = fig.add_axes([ax_x0, 0.05, ax_width, 0.05])\n plt.sca(map_ax)\n else:\n ax_y0, ax_height = 0.05, 0.85\n if projection == \"local\":\n ax_y0 += 0.05\n ax_height -= 0.05\n map_ax = fig.add_axes([ax_x0, ax_y0, ax_width, ax_height],\n projection=proj)\n\n if projection == 'local':\n x0, y0 = proj.transform_point(lon_0, lat_0, proj.as_geodetic())\n map_ax.set_xlim(x0 - width / 2, x0 + width / 2)\n map_ax.set_ylim(y0 - height / 2, y0 + height / 2)\n else:\n map_ax.set_global()\n\n # Pick features at specified resolution.\n resolution = _CARTOPY_RESOLUTIONS[resolution]\n try:\n borders, land, ocean = _CARTOPY_FEATURES[resolution]\n except KeyError:\n borders = cfeature.NaturalEarthFeature(cfeature.BORDERS.category,\n cfeature.BORDERS.name,\n resolution,\n edgecolor='none',\n facecolor='none')\n land = cfeature.NaturalEarthFeature(cfeature.LAND.category,\n cfeature.LAND.name, resolution,\n edgecolor='face', facecolor='none')\n ocean = cfeature.NaturalEarthFeature(cfeature.OCEAN.category,\n cfeature.OCEAN.name, resolution,\n edgecolor='face',\n facecolor='none')\n _CARTOPY_FEATURES[resolution] = (borders, land, ocean)\n\n # Draw coast lines, country boundaries, fill continents.\n if MATPLOTLIB_VERSION >= [2, 0, 0]:\n map_ax.set_facecolor(water_fill_color)\n else:\n map_ax.set_axis_bgcolor(water_fill_color)\n map_ax.add_feature(ocean, facecolor=water_fill_color)\n map_ax.add_feature(land, facecolor=continent_fill_color)\n map_ax.add_feature(borders, edgecolor='0.75')\n map_ax.coastlines(resolution=resolution, color='0.4')\n\n # Draw grid lines - TODO: draw_labels=True doesn't work yet.\n if projection == 'local':\n map_ax.gridlines()\n else:\n # Draw lat/lon grid lines every 30 degrees.\n map_ax.gridlines(xlocs=range(-180, 181, 30), ylocs=range(-90, 91, 30))\n\n # Plot labels\n if labels and len(lons) > 0:\n with map_ax.hold_limits():\n for name, xpt, ypt, _colorpt in zip(labels, lons, lats, color):\n map_ax.text(xpt, ypt, name, weight=\"heavy\", color=\"k\",\n zorder=100, transform=ccrs.Geodetic(),\n path_effects=[\n PathEffects.withStroke(linewidth=3,\n foreground=\"white\")])\n\n scatter = map_ax.scatter(lons, lats, marker=marker, s=size, c=color,\n zorder=10, cmap=colormap,\n transform=ccrs.Geodetic())\n\n if title:\n plt.suptitle(title)\n\n # Only show the colorbar for more than one event.\n if show_colorbar:\n if colorbar_ticklabel_format is not None:\n if isinstance(colorbar_ticklabel_format, (str, native_str)):\n formatter = FormatStrFormatter(colorbar_ticklabel_format)\n elif hasattr(colorbar_ticklabel_format, '__call__'):\n formatter = FuncFormatter(colorbar_ticklabel_format)\n elif isinstance(colorbar_ticklabel_format, Formatter):\n formatter = colorbar_ticklabel_format\n locator = MaxNLocator(5)\n else:\n if datetimeplot:\n locator = AutoDateLocator()\n formatter = AutoDateFormatter(locator)\n # Compat with old matplotlib versions.\n if hasattr(formatter, \"scaled\"):\n formatter.scaled[1 / (24. * 60.)] = '%H:%M:%S'\n else:\n locator = None\n formatter = None\n cb = Colorbar(cm_ax, scatter, cmap=colormap,\n orientation='horizontal',\n ticks=locator,\n format=formatter)\n # Compat with old matplotlib versions.\n if hasattr(cb, \"update_ticks\"):\n cb.update_ticks()\n\n if show:\n plt.show()\n\n return fig\n\n\ndef plot_map(method, args, kwargs):\n '''\n Creates a map plot with a data point scatter plot.\n\n :type method: str\n :param method: Method to use for plotting. Possible values are:\n\n ``'basemap'`` to use the Basemap library. For other arguments, see\n the :func:`plot_basemap` function.\n * ``'cartopy'`` to use the Cartopy library. For other arguments, see\n the :func:`plot_cartopy` function.\n * ``None`` to use either the Basemap or Cartopy library, whichever is\n available.\n '''\n\n if method is None:\n if HAS_BASEMAP:\n return plot_basemap(args, kwargs)\n elif HAS_CARTOPY:\n return plot_cartopy(args, *kwargs)\n else:\n raise ImportError('Neither Basemap nor Cartopy could be imported.')\n elif method == 'basemap':\n if not HAS_BASEMAP:\n raise ImportError('Basemap cannot be imported but was explicitly '\n 'requested.')\n return plot_basemap(args, *kwargs)\n elif method == 'cartopy':\n if not HAS_CARTOPY:\n raise ImportError('Cartopy cannot be imported but was explicitly '\n 'requested.')\n return plot_cartopy(args, **kwargs)\n else:\n raise ValueError(\"The method argument must be either 'basemap' or \"\n \"'cartopy', not '%s'.\" % (method, ))\n", "path": "obspy/imaging/maps.py" } ]	diff --git a/CHANGELOG.txt b/CHANGELOG.txt index de4973fde94..5850c9afe37 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -26,6 +26,8 @@ - obspy.imaging: * Normalize moment tensors prior to plotting in the mopad wrapper to stabilize the algorithm (see #2114, #2125). + * fix some map plotting issues with cartopy and local projection (see #2193, + #2204) - obspy.io.ascii: * Fixes an issue with the time representation (see #2165, #2179). - obspy.io.css: diff --git a/obspy/CONTRIBUTORS.txt b/obspy/CONTRIBUTORS.txt index 7108e5f6b65..da327e3191b 100644 --- a/obspy/CONTRIBUTORS.txt +++ b/obspy/CONTRIBUTORS.txt @@ -1,4 +1,5 @@ Ackerley, Nick +Allgeyer, Sebastien Ammon, Charles J. Antunes, Emanuel Arnarsson, Ólafur St. diff --git a/obspy/imaging/maps.py b/obspy/imaging/maps.py index 51e13cda114..08425306a5e 100644 --- a/obspy/imaging/maps.py +++ b/obspy/imaging/maps.py @@ -627,6 +627,7 @@ def plot_cartopy(lons, lats, size, color, labels=None, projection='global', proj_kwargs['central_latitude'] = lat_0 proj_kwargs['central_longitude'] = lon_0 + proj_kwargs['standard_parallels'] = [lat_0, lat_0] proj = ccrs.AlbersEqualArea(**proj_kwargs) # User-supplied projection.
bokeh__bokeh-10308	bokehjs' version has duplicated dev suffix ```sh $ jq '.version' bokehjs/package.json "2.2.0dev4-dev.4" ``` Should be `2.2.0-dev.4` instead.	[ { "content": "# -----------------------------------------------------------------------------\n# Copyright (c) 2012 - 2020, Anaconda, Inc., and Bokeh Contributors.\n# All rights reserved.\n#\n# The full license is in the file LICENSE.txt, distributed with this software.\n# -----------------------------------------------------------------------------\n\"\"\"\n\n\"\"\"\n\n# Standard library imports\nimport re\nfrom typing import Dict, Optional, Tuple\n\n# Bokeh imports\nfrom .enums import VersionType\nfrom .logger import LOG, Scrubber\n\n__all__ = (\"Config\",)\n\n# This excludes \"local\" build versions, e.g. 0.12.4+19.gf85560a\nANY_VERSION = re.compile(r\"^((\\d+)\\.(\\d+)\\.(\\d+))((dev\|rc)(\\d+))?$\")\n\nFULL_VERSION = re.compile(r\"^(\\d+\\.\\d+\\.\\d+)$\")\n\n\nclass Config(object):\n def __init__(self, version: str) -> None:\n m = ANY_VERSION.match(version)\n if not m:\n raise ValueError(f\"Invalid version for Bokeh build/release {version!r}\")\n groups = m.groups()\n\n self.version: str = version\n\n self.base_version: str = groups[0]\n self.base_version_tuple: Tuple[str, ...] = tuple(groups[1:4])\n self.ext: Optional[str] = groups[4]\n self.ext_type: str = groups[5]\n self.ext_number: str = groups[6]\n\n self._secrets: Dict[str, str] = {}\n\n def add_secret(self, name: str, secret: str) -> None:\n \"\"\"\n\n \"\"\"\n if name in self._secrets:\n raise RuntimeError()\n LOG.add_scrubber(Scrubber(secret, name=name))\n self._secrets[name] = secret\n\n @property\n def secrets(self) -> Dict[str, str]:\n return self._secrets\n\n @property\n def prerelease(self) -> bool:\n return self.version_type != VersionType.FULL\n\n @property\n def version_type(self) -> VersionType:\n if \"rc\" in self.version:\n return VersionType.RC\n elif \"dev\" in self.version:\n return VersionType.DEV\n else:\n return VersionType.FULL\n\n @property\n def js_version(self) -> str:\n if self.ext is None:\n return self.version\n return f\"{self.version}-{self.ext_type}.{self.ext_number}\"\n\n @property\n def release_level(self) -> str:\n major, minor = self.base_version_tuple[:2]\n return f\"{major}.{minor}\"\n\n @property\n def staging_branch(self) -> str:\n return f\"staging-{self.version}\"\n\n @property\n def base_branch(self) -> str:\n return f\"branch-{self.release_level}\"\n", "path": "release/config.py" } ]	[ { "content": "# -----------------------------------------------------------------------------\n# Copyright (c) 2012 - 2020, Anaconda, Inc., and Bokeh Contributors.\n# All rights reserved.\n#\n# The full license is in the file LICENSE.txt, distributed with this software.\n# -----------------------------------------------------------------------------\n\"\"\"\n\n\"\"\"\n\n# Standard library imports\nimport re\nfrom typing import Dict, Optional, Tuple\n\n# Bokeh imports\nfrom .enums import VersionType\nfrom .logger import LOG, Scrubber\n\n__all__ = (\"Config\",)\n\n# This excludes \"local\" build versions, e.g. 0.12.4+19.gf85560a\nANY_VERSION = re.compile(r\"^((\\d+)\\.(\\d+)\\.(\\d+))((dev\|rc)(\\d+))?$\")\n\nFULL_VERSION = re.compile(r\"^(\\d+\\.\\d+\\.\\d+)$\")\n\n\nclass Config(object):\n def __init__(self, version: str) -> None:\n m = ANY_VERSION.match(version)\n if not m:\n raise ValueError(f\"Invalid version for Bokeh build/release {version!r}\")\n groups = m.groups()\n\n self.version: str = version\n\n self.base_version: str = groups[0]\n self.base_version_tuple: Tuple[str, ...] = tuple(groups[1:4])\n self.ext: Optional[str] = groups[4]\n self.ext_type: str = groups[5]\n self.ext_number: str = groups[6]\n\n self._secrets: Dict[str, str] = {}\n\n def add_secret(self, name: str, secret: str) -> None:\n \"\"\"\n\n \"\"\"\n if name in self._secrets:\n raise RuntimeError()\n LOG.add_scrubber(Scrubber(secret, name=name))\n self._secrets[name] = secret\n\n @property\n def secrets(self) -> Dict[str, str]:\n return self._secrets\n\n @property\n def prerelease(self) -> bool:\n return self.version_type != VersionType.FULL\n\n @property\n def version_type(self) -> VersionType:\n if \"rc\" in self.version:\n return VersionType.RC\n elif \"dev\" in self.version:\n return VersionType.DEV\n else:\n return VersionType.FULL\n\n @property\n def js_version(self) -> str:\n if self.ext is None:\n return self.version\n return f\"{self.base_version}-{self.ext_type}.{self.ext_number}\"\n\n @property\n def release_level(self) -> str:\n major, minor = self.base_version_tuple[:2]\n return f\"{major}.{minor}\"\n\n @property\n def staging_branch(self) -> str:\n return f\"staging-{self.version}\"\n\n @property\n def base_branch(self) -> str:\n return f\"branch-{self.release_level}\"\n", "path": "release/config.py" } ]	diff --git a/ci/environment-test-3.6.yml b/ci/environment-test-3.6.yml index feb684fac01..b9556657501 100644 --- a/ci/environment-test-3.6.yml +++ b/ci/environment-test-3.6.yml @@ -28,7 +28,7 @@ dependencies: - flaky - geckodriver - ipython - - isort >=4.3.21 + - isort <5.0 - mock - mypy - nbconvert >=5.4 diff --git a/ci/environment-test-3.7.yml b/ci/environment-test-3.7.yml index 51d82100693..1c1f85bc13f 100644 --- a/ci/environment-test-3.7.yml +++ b/ci/environment-test-3.7.yml @@ -28,7 +28,7 @@ dependencies: - flaky - geckodriver - ipython - - isort >=4.3.21 + - isort <5.0 - mock - mypy - nbconvert >=5.4 diff --git a/ci/environment-test-3.8.yml b/ci/environment-test-3.8.yml index 48d0f7a50f4..e3681a55b8d 100644 --- a/ci/environment-test-3.8.yml +++ b/ci/environment-test-3.8.yml @@ -28,7 +28,7 @@ dependencies: - flaky - geckodriver - ipython - - isort >=4.3.21 + - isort <5.0 - mock - mypy - nbconvert >=5.4 diff --git a/environment.yml b/environment.yml index a28af662fd6..622fdba080b 100644 --- a/environment.yml +++ b/environment.yml @@ -36,7 +36,7 @@ dependencies: - flaky - geckodriver - ipython - - isort >=4.3.21 + - isort <5.0 - mock - mypy - nbconvert >=5.4 diff --git a/release/config.py b/release/config.py index 7cdfcf4ebd6..b501151633d 100644 --- a/release/config.py +++ b/release/config.py @@ -71,7 +71,7 @@ def version_type(self) -> VersionType: def js_version(self) -> str: if self.ext is None: return self.version - return f"{self.version}-{self.ext_type}.{self.ext_number}" + return f"{self.base_version}-{self.ext_type}.{self.ext_number}" @property def release_level(self) -> str:
akvo__akvo-rsr-2604	urgent: projects missing iggwater.akvoapp.org Created via Reamaze: Link: https://rsrsupport.reamaze.com/admin/conversations/urgent-projects-missing-iggwater-dot-akvoapp-dot-org Assignee: Anthony Gonzalez Message: Hi RSR-team, Just wanted to visit iggwater.akvoapp.org, but somehow all projects that were previously shown there are gone and the page is now empty. Can you look into this? Cheers, Annabelle Poelert Project Officer Akvo • 's-Gravenhekje 1A • 1011 TG • Amsterdam (NL) T +31 20 8200 175 • S Annabelle.akvo • T @annabellepoel I www.akvo.org <http://www.akvo.org/>	[ { "content": "# -- coding: utf-8 --\n\"\"\"\nAkvo RSR is covered by the GNU Affero General Public License.\n\nSee more details in the license.txt file located at the root folder of the\nAkvo RSR module. For additional details on the GNU license please see\n< http://www.gnu.org/licenses/agpl.html >.\n\"\"\"\n\nimport django_filters\nimport json\nfrom datetime import datetime\nfrom sorl.thumbnail import get_thumbnail\n\nfrom django.conf import settings\nfrom django.contrib.auth.decorators import login_required\nfrom django.core.exceptions import PermissionDenied\nfrom django.core.urlresolvers import reverse\nfrom django.http import Http404, HttpResponse, HttpResponseRedirect\nfrom django.shortcuts import get_object_or_404, redirect, render\nfrom django.utils.translation import ugettext_lazy as _\nfrom lxml import etree\n\nfrom ..forms import ProjectUpdateForm\nfrom ..filters import (build_choices, location_choices, create_project_filter_class,\n remove_empty_querydict_items)\nfrom ..models import Project, ProjectUpdate\nfrom ...utils import pagination, filter_query_string\nfrom ...iati.exports.iati_export import IatiXML\nfrom .organisation import _page_organisations\nfrom akvo.codelists.models import SectorCategory, Sector, Version\n\n\n###############################################################################\n# Project directory\n###############################################################################\n\n\ndef _project_directory_coll(request):\n \"\"\"Dig out and pass correct projects to the view.\"\"\"\n page = request.rsr_page\n return (\n page.organisation.published_projects() if page is not None\n else Project.objects.public().published()\n )\n\n\ndef directory(request):\n \"\"\"The project list view.\"\"\"\n qs = remove_empty_querydict_items(request.GET)\n\n # Set show_filters to \"in\" if any filter is selected\n show_filters = \"in\" # To simplify template use bootstrap class\n available_filters = [\n 'location', 'status', 'iati_status', 'organisation', 'sector', 'keyword', 'sort_by'\n ]\n if frozenset(qs.keys()).isdisjoint(available_filters):\n show_filters = \"\"\n\n # Prepare sorting\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\n '-title', 'budget', '-budget', ]\n sort_by = request.GET.get('sort_by', '-last_modified_at')\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\n\n # Yank project collection\n all_projects = _project_directory_coll(request)\n f = create_project_filter_class(request)(qs, queryset=all_projects)\n\n # Change filter options further when on an Akvo Page\n if request.rsr_page:\n # Filter location filter list to only populated locations\n f.filters['location'].extra['choices'] = location_choices(all_projects)\n\n # Swap to choice filter for RSR pages\n f.filters['organisation'] = django_filters.ChoiceFilter(\n choices=build_choices(_page_organisations(request.rsr_page)),\n label=_(u'organisation'),\n name='partners__id')\n\n sorted_projects = f.qs.distinct().order_by(sorting)\n\n # Build page\n page_number = request.GET.get('page')\n limit = request.GET.get('limit', settings.PROJECT_DIRECTORY_PAGE_SIZES[0])\n limit = min(int(limit), settings.PROJECT_DIRECTORY_PAGE_SIZES[-1])\n page, paginator, page_range = pagination(page_number, sorted_projects, limit)\n start_index = page.start_index()\n page_info = [\n (start_index // size + 1, size)\n for size in settings.PROJECT_DIRECTORY_PAGE_SIZES\n ]\n\n # Get the current org filter for typeahead\n org_filter = request.GET.get('organisation', '')\n\n # Get projects to be displayed on the map\n if request.rsr_page and request.rsr_page.all_maps:\n map_projects = all_projects\n else:\n map_projects = page.object_list\n map_projects = map_projects.select_related('primary_location')\n\n # Get related objects of page at once\n page.object_list = page.object_list.prefetch_related(\n 'publishingstatus',\n 'recipient_countries',\n 'sectors',\n 'budget_items',\n 'partnerships__organisation',\n ).select_related(\n 'primary_organisation',\n 'last_update'\n )\n\n # Get all sector categories in a dict\n try:\n iati_version_obj = Version.objects.get(code=settings.IATI_VERSION)\n sector_cats = SectorCategory.objects.filter(version=iati_version_obj)\n sectors = Sector.objects.filter(version=iati_version_obj)\n except (Version.MultipleObjectsReturned, Version.DoesNotExist):\n sector_cats = []\n sectors = []\n\n sectors_dict = {}\n for sector_cat in sector_cats:\n sectors_dict[str(sector_cat.code)] = sector_cat.name\n for sector in sectors:\n sectors_dict[str(sector.code)] = sector.name\n\n context = {\n 'project_count': sorted_projects.count(),\n 'filter': f,\n 'page_info': page_info,\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'show_filters': show_filters,\n 'q': filter_query_string(qs),\n 'sorting': sorting,\n 'current_org': org_filter,\n 'map_projects': map_projects,\n 'sectors_dict': sectors_dict,\n }\n return render(request, 'project_directory.html', context)\n\n\n###############################################################################\n# Project main\n###############################################################################\n\ndef _check_project_viewing_permissions(user, project):\n \"\"\"\n Checks if the user can view a project, otherwise raises a PermissionDenied exception.\n\n A user can view any public project, but when a project is private or not published the user\n should be logged in and able to make changes to the project (e.g. be an admin of the project).\n \"\"\"\n if not ((project.is_public and project.is_published()) or\n user.has_perm('rsr.view_project', project)):\n raise PermissionDenied\n\n\ndef _get_carousel_data(project, updates):\n photos = []\n if project.current_image:\n try:\n im = get_thumbnail(project.current_image, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": project.current_image_caption,\n \"credit\": project.current_image_credit,\n \"direct_to_url\": '',\n })\n except IOError:\n pass\n for update in updates:\n if update.photo:\n direct_to = reverse('update-main', kwargs={\n 'project_id': project.pk,\n 'update_id': update.pk\n })\n try:\n im = get_thumbnail(update.photo, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": update.photo_caption,\n \"credit\": update.photo_credit,\n \"direct_to_url\": direct_to,\n })\n except IOError:\n continue\n return {\"photos\": photos}\n\n\ndef _get_hierarchy_row(max_rows, projects):\n \"\"\"Return a column for the project hierarchy with a division.\n\n E.g. with a max_rows of 4 and one project, it will return [False,\n <Project>, False, False].\n \"\"\"\n project_count = projects.count()\n if max_rows == project_count:\n return [project for project in projects]\n empty_begin = (max_rows - project_count) / 2\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\n rows = []\n for row in range(empty_begin):\n rows.append(False)\n for project in projects:\n rows.append(project)\n for row in range(empty_end):\n rows.append(False)\n return rows\n\n\ndef _get_hierarchy_grid(project):\n parents = project.parents()\n siblings = project.siblings()\n children = project.children()\n\n # Create the lay-out of the grid\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\n parent_rows = _get_hierarchy_row(max_rows, parents)\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\n siblings_rows.insert((max_rows - 1) / 2, 'project')\n children_rows = _get_hierarchy_row(max_rows, children)\n\n grid = []\n project_added = False\n for row in range(max_rows):\n grid.append([])\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\n if siblings_rows[row] == 'project':\n grid[row].append([project, 'project'])\n project_added = True\n elif not project_added:\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\n else:\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\n\n return grid\n\n\ndef main(request, project_id):\n \"\"\"\n The main project page, consisting of 6 tabs:\n\n - 'Summary'\n - 'Full report'\n - 'Project partners'\n - 'Finances'\n - 'Results' (optional, only when project has results)\n - 'Updates' (optional, only when project has updates)\n\n :param request; Django request.\n :param project_id; ID of a Project object.\n :return A rendered project page.\n \"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Permissions\n _check_project_viewing_permissions(request.user, project)\n\n # Updates\n updates = project.project_updates.prefetch_related('user').order_by('-created_at')\n page = request.GET.get('page')\n page, paginator, page_range = pagination(page, updates, 10)\n\n # Related documents\n related_documents = []\n for d in project.documents.all():\n if d.url or d.document:\n related_documents += [d]\n related_documents = related_documents[:5]\n\n # JSON data\n carousel_data = json.dumps(_get_carousel_data(project, updates[:9]))\n accordion_data = json.dumps({\n 'background': project.background,\n 'current_status': project.current_status,\n 'project_plan': project.project_plan,\n 'target_group': project.target_group,\n 'sustainability': project.sustainability,\n 'goals_overview': project.goals_overview\n })\n\n context = {\n 'accordion_data': accordion_data,\n 'carousel_data': carousel_data,\n 'current_datetime': datetime.now(),\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'pledged': project.get_pledged(),\n 'project': project,\n 'related_documents': related_documents,\n 'updates': updates[:5] if updates else None,\n 'update_timeout': settings.PROJECT_UPDATE_TIMEOUT,\n 'parent_projects_ids': [parent_project.id for parent_project in project.parents()],\n 'child_projects_ids': [child_project.id for child_project in project.children()],\n }\n\n return render(request, 'project_main.html', context)\n\n\n#####################\n# Project hierarchy #\n#####################\n\n\ndef hierarchy(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n _check_project_viewing_permissions(request.user, project)\n\n if not project.has_relations():\n raise Http404\n\n hierarchy_grid = _get_hierarchy_grid(project)\n\n context = {\n 'project': project,\n 'hierarchy_grid': hierarchy_grid,\n }\n\n return render(request, 'project_hierarchy.html', context)\n\n\n###############################################################################################\n# Old links, now incorporated in tabs of the project main page, will redirect to project main #\n###############################################################################################\n\n\ndef report(request, project_id):\n \"\"\"Show the full data report tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#report'\n )\n\n\ndef partners(request, project_id):\n \"\"\"Show the partners tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#partners'\n )\n\n\ndef finance(request, project_id):\n \"\"\"Show finance tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#finance'\n )\n\n###############################################################################\n# Project IATI file\n###############################################################################\n\n\ndef iati(request, project_id):\n \"\"\"Generate the IATI file on-the-fly and return the XML.\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n if not project.is_public:\n raise PermissionDenied\n xml_data = etree.tostring(etree.ElementTree(IatiXML([project]).iati_activities))\n return HttpResponse(xml_data, content_type=\"text/xml\")\n\n\n###############################################################################\n# Project widgets\n###############################################################################\n\n\ndef widgets(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n selected_widget = request.GET.get('widget', None)\n\n # Do not show private projects, and non-editors are not allowed to view unpublished projects\n if not project.is_public or \\\n (not project.is_published() and not request.user.is_anonymous() and\n not request.user.has_perm('rsr.change_project', project)):\n raise PermissionDenied\n\n context = {\n 'project': project,\n 'style': 'darkBG',\n }\n\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\n context['widget'] = selected_widget\n context['domain_url'] = '{}://{}'.format(request.scheme, request.META['HTTP_HOST'])\n return render(request, 'project_widgets2.html', context)\n\n else:\n return render(request, 'project_widgets.html', context)\n\n\n@login_required()\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, id=project_id)\n\n # Permissions\n _check_project_viewing_permissions(request.user, project)\n\n # Check if user is allowed to place updates for this project\n allow_update = True if request.user.has_perm('rsr.post_updates', project) else False\n\n updates = project.updates_desc()[:5]\n update = None\n update_user = None\n\n if update_id is not None:\n edit_mode = True\n update = get_object_or_404(ProjectUpdate, id=update_id)\n update_user = update.user.get_full_name()\n if not request.user == update.user and not request.user.can_edit_update(update):\n request.error_message = u'You can only edit your own updates.'\n raise PermissionDenied\n\n # Prevent adding update if project is completed, cancelled or unpublished\n elif project.iati_status in Project.EDIT_DISABLED or not project.is_published():\n request.error_message = u'Cannot add updates to completed or unpublished projects.'\n raise PermissionDenied\n\n if request.method == 'POST':\n updateform = form_class(request.POST, request.FILES, instance=update)\n if updateform.is_valid():\n if update:\n update = updateform.save(project=project, user=update.user)\n else:\n update = updateform.save(project=project, user=request.user)\n return redirect(update.get_absolute_url())\n else:\n # Django forms takes care of this, and displays the errors!\n pass\n else:\n updateform = form_class(instance=update)\n\n context = {\n 'project': project,\n 'updates': updates,\n 'update': update,\n 'update_user': update_user,\n 'updateform': updateform,\n 'edit_mode': edit_mode,\n 'allow_update': allow_update\n }\n\n return render(request, 'update_add.html', context)\n", "path": "akvo/rsr/views/project.py" } ]	[ { "content": "# -- coding: utf-8 --\n\"\"\"\nAkvo RSR is covered by the GNU Affero General Public License.\n\nSee more details in the license.txt file located at the root folder of the\nAkvo RSR module. For additional details on the GNU license please see\n< http://www.gnu.org/licenses/agpl.html >.\n\"\"\"\n\nimport django_filters\nimport json\nfrom datetime import datetime\nfrom sorl.thumbnail import get_thumbnail\n\nfrom django.conf import settings\nfrom django.contrib.auth.decorators import login_required\nfrom django.core.exceptions import PermissionDenied\nfrom django.core.urlresolvers import reverse\nfrom django.http import Http404, HttpResponse, HttpResponseRedirect\nfrom django.shortcuts import get_object_or_404, redirect, render\nfrom django.utils.translation import ugettext_lazy as _\nfrom lxml import etree\n\nfrom ..forms import ProjectUpdateForm\nfrom ..filters import (build_choices, location_choices, create_project_filter_class,\n remove_empty_querydict_items)\nfrom ..models import Project, ProjectUpdate\nfrom ...utils import pagination, filter_query_string\nfrom ...iati.exports.iati_export import IatiXML\nfrom .organisation import _page_organisations\nfrom akvo.codelists.models import SectorCategory, Sector, Version\n\n\n###############################################################################\n# Project directory\n###############################################################################\n\n\ndef _project_directory_coll(request):\n \"\"\"Dig out and pass correct projects to the view.\"\"\"\n page = request.rsr_page\n return (\n page.projects() if page is not None\n else Project.objects.public().published()\n )\n\n\ndef directory(request):\n \"\"\"The project list view.\"\"\"\n qs = remove_empty_querydict_items(request.GET)\n\n # Set show_filters to \"in\" if any filter is selected\n show_filters = \"in\" # To simplify template use bootstrap class\n available_filters = [\n 'location', 'status', 'iati_status', 'organisation', 'sector', 'keyword', 'sort_by'\n ]\n if frozenset(qs.keys()).isdisjoint(available_filters):\n show_filters = \"\"\n\n # Prepare sorting\n available_sorting = ['last_modified_at', '-last_modified_at', 'title',\n '-title', 'budget', '-budget', ]\n sort_by = request.GET.get('sort_by', '-last_modified_at')\n sorting = sort_by if sort_by in available_sorting else '-last_modified_at'\n\n # Yank project collection\n all_projects = _project_directory_coll(request)\n f = create_project_filter_class(request)(qs, queryset=all_projects)\n\n # Change filter options further when on an Akvo Page\n if request.rsr_page:\n # Filter location filter list to only populated locations\n f.filters['location'].extra['choices'] = location_choices(all_projects)\n\n # Swap to choice filter for RSR pages\n f.filters['organisation'] = django_filters.ChoiceFilter(\n choices=build_choices(_page_organisations(request.rsr_page)),\n label=_(u'organisation'),\n name='partners__id')\n\n sorted_projects = f.qs.distinct().order_by(sorting)\n\n # Build page\n page_number = request.GET.get('page')\n limit = request.GET.get('limit', settings.PROJECT_DIRECTORY_PAGE_SIZES[0])\n limit = min(int(limit), settings.PROJECT_DIRECTORY_PAGE_SIZES[-1])\n page, paginator, page_range = pagination(page_number, sorted_projects, limit)\n start_index = page.start_index()\n page_info = [\n (start_index // size + 1, size)\n for size in settings.PROJECT_DIRECTORY_PAGE_SIZES\n ]\n\n # Get the current org filter for typeahead\n org_filter = request.GET.get('organisation', '')\n\n # Get projects to be displayed on the map\n if request.rsr_page and request.rsr_page.all_maps:\n map_projects = all_projects\n else:\n map_projects = page.object_list\n map_projects = map_projects.select_related('primary_location')\n\n # Get related objects of page at once\n page.object_list = page.object_list.prefetch_related(\n 'publishingstatus',\n 'recipient_countries',\n 'sectors',\n 'budget_items',\n 'partnerships__organisation',\n ).select_related(\n 'primary_organisation',\n 'last_update'\n )\n\n # Get all sector categories in a dict\n try:\n iati_version_obj = Version.objects.get(code=settings.IATI_VERSION)\n sector_cats = SectorCategory.objects.filter(version=iati_version_obj)\n sectors = Sector.objects.filter(version=iati_version_obj)\n except (Version.MultipleObjectsReturned, Version.DoesNotExist):\n sector_cats = []\n sectors = []\n\n sectors_dict = {}\n for sector_cat in sector_cats:\n sectors_dict[str(sector_cat.code)] = sector_cat.name\n for sector in sectors:\n sectors_dict[str(sector.code)] = sector.name\n\n context = {\n 'project_count': sorted_projects.count(),\n 'filter': f,\n 'page_info': page_info,\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'show_filters': show_filters,\n 'q': filter_query_string(qs),\n 'sorting': sorting,\n 'current_org': org_filter,\n 'map_projects': map_projects,\n 'sectors_dict': sectors_dict,\n }\n return render(request, 'project_directory.html', context)\n\n\n###############################################################################\n# Project main\n###############################################################################\n\ndef _check_project_viewing_permissions(user, project):\n \"\"\"\n Checks if the user can view a project, otherwise raises a PermissionDenied exception.\n\n A user can view any public project, but when a project is private or not published the user\n should be logged in and able to make changes to the project (e.g. be an admin of the project).\n \"\"\"\n if not ((project.is_public and project.is_published()) or\n user.has_perm('rsr.view_project', project)):\n raise PermissionDenied\n\n\ndef _get_carousel_data(project, updates):\n photos = []\n if project.current_image:\n try:\n im = get_thumbnail(project.current_image, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": project.current_image_caption,\n \"credit\": project.current_image_credit,\n \"direct_to_url\": '',\n })\n except IOError:\n pass\n for update in updates:\n if update.photo:\n direct_to = reverse('update-main', kwargs={\n 'project_id': project.pk,\n 'update_id': update.pk\n })\n try:\n im = get_thumbnail(update.photo, '750x400', quality=99)\n photos.append({\n \"url\": im.url,\n \"caption\": update.photo_caption,\n \"credit\": update.photo_credit,\n \"direct_to_url\": direct_to,\n })\n except IOError:\n continue\n return {\"photos\": photos}\n\n\ndef _get_hierarchy_row(max_rows, projects):\n \"\"\"Return a column for the project hierarchy with a division.\n\n E.g. with a max_rows of 4 and one project, it will return [False,\n <Project>, False, False].\n \"\"\"\n project_count = projects.count()\n if max_rows == project_count:\n return [project for project in projects]\n empty_begin = (max_rows - project_count) / 2\n empty_end = (max_rows - project_count) / 2 + ((max_rows - project_count) % 2)\n rows = []\n for row in range(empty_begin):\n rows.append(False)\n for project in projects:\n rows.append(project)\n for row in range(empty_end):\n rows.append(False)\n return rows\n\n\ndef _get_hierarchy_grid(project):\n parents = project.parents()\n siblings = project.siblings()\n children = project.children()\n\n # Create the lay-out of the grid\n max_rows = max(parents.count(), siblings.count() + 1, children.count())\n parent_rows = _get_hierarchy_row(max_rows, parents)\n siblings_rows = _get_hierarchy_row(max_rows - 1, siblings)\n siblings_rows.insert((max_rows - 1) / 2, 'project')\n children_rows = _get_hierarchy_row(max_rows, children)\n\n grid = []\n project_added = False\n for row in range(max_rows):\n grid.append([])\n grid[row].append([parent_rows[row], 'parent']) if parent_rows[row] else grid[row].append(None)\n if siblings_rows[row] == 'project':\n grid[row].append([project, 'project'])\n project_added = True\n elif not project_added:\n grid[row].append([siblings_rows[row], 'sibling-top']) if siblings_rows[row] else grid[row].append(None)\n else:\n grid[row].append([siblings_rows[row], 'sibling-bottom']) if siblings_rows[row] else grid[row].append(None)\n grid[row].append([children_rows[row], 'child']) if children_rows[row] else grid[row].append(None)\n\n return grid\n\n\ndef main(request, project_id):\n \"\"\"\n The main project page, consisting of 6 tabs:\n\n - 'Summary'\n - 'Full report'\n - 'Project partners'\n - 'Finances'\n - 'Results' (optional, only when project has results)\n - 'Updates' (optional, only when project has updates)\n\n :param request; Django request.\n :param project_id; ID of a Project object.\n :return A rendered project page.\n \"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Permissions\n _check_project_viewing_permissions(request.user, project)\n\n # Updates\n updates = project.project_updates.prefetch_related('user').order_by('-created_at')\n page = request.GET.get('page')\n page, paginator, page_range = pagination(page, updates, 10)\n\n # Related documents\n related_documents = []\n for d in project.documents.all():\n if d.url or d.document:\n related_documents += [d]\n related_documents = related_documents[:5]\n\n # JSON data\n carousel_data = json.dumps(_get_carousel_data(project, updates[:9]))\n accordion_data = json.dumps({\n 'background': project.background,\n 'current_status': project.current_status,\n 'project_plan': project.project_plan,\n 'target_group': project.target_group,\n 'sustainability': project.sustainability,\n 'goals_overview': project.goals_overview\n })\n\n context = {\n 'accordion_data': accordion_data,\n 'carousel_data': carousel_data,\n 'current_datetime': datetime.now(),\n 'page': page,\n 'page_range': page_range,\n 'paginator': paginator,\n 'pledged': project.get_pledged(),\n 'project': project,\n 'related_documents': related_documents,\n 'updates': updates[:5] if updates else None,\n 'update_timeout': settings.PROJECT_UPDATE_TIMEOUT,\n 'parent_projects_ids': [parent_project.id for parent_project in project.parents()],\n 'child_projects_ids': [child_project.id for child_project in project.children()],\n }\n\n return render(request, 'project_main.html', context)\n\n\n#####################\n# Project hierarchy #\n#####################\n\n\ndef hierarchy(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n\n # Non-editors are not allowed to view unpublished projects\n _check_project_viewing_permissions(request.user, project)\n\n if not project.has_relations():\n raise Http404\n\n hierarchy_grid = _get_hierarchy_grid(project)\n\n context = {\n 'project': project,\n 'hierarchy_grid': hierarchy_grid,\n }\n\n return render(request, 'project_hierarchy.html', context)\n\n\n###############################################################################################\n# Old links, now incorporated in tabs of the project main page, will redirect to project main #\n###############################################################################################\n\n\ndef report(request, project_id):\n \"\"\"Show the full data report tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#report'\n )\n\n\ndef partners(request, project_id):\n \"\"\"Show the partners tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#partners'\n )\n\n\ndef finance(request, project_id):\n \"\"\"Show finance tab on the project main page.\"\"\"\n return HttpResponseRedirect(\n reverse('project-main', kwargs={'project_id': project_id}) + '#finance'\n )\n\n###############################################################################\n# Project IATI file\n###############################################################################\n\n\ndef iati(request, project_id):\n \"\"\"Generate the IATI file on-the-fly and return the XML.\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n if not project.is_public:\n raise PermissionDenied\n xml_data = etree.tostring(etree.ElementTree(IatiXML([project]).iati_activities))\n return HttpResponse(xml_data, content_type=\"text/xml\")\n\n\n###############################################################################\n# Project widgets\n###############################################################################\n\n\ndef widgets(request, project_id):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, pk=project_id)\n selected_widget = request.GET.get('widget', None)\n\n # Do not show private projects, and non-editors are not allowed to view unpublished projects\n if not project.is_public or \\\n (not project.is_published() and not request.user.is_anonymous() and\n not request.user.has_perm('rsr.change_project', project)):\n raise PermissionDenied\n\n context = {\n 'project': project,\n 'style': 'darkBG',\n }\n\n if selected_widget in ['narrow', 'cobranded', 'small', 'map', 'list']:\n context['widget'] = selected_widget\n context['domain_url'] = '{}://{}'.format(request.scheme, request.META['HTTP_HOST'])\n return render(request, 'project_widgets2.html', context)\n\n else:\n return render(request, 'project_widgets.html', context)\n\n\n@login_required()\ndef set_update(request, project_id, edit_mode=False, form_class=ProjectUpdateForm, update_id=None):\n \"\"\".\"\"\"\n project = get_object_or_404(Project, id=project_id)\n\n # Permissions\n _check_project_viewing_permissions(request.user, project)\n\n # Check if user is allowed to place updates for this project\n allow_update = True if request.user.has_perm('rsr.post_updates', project) else False\n\n updates = project.updates_desc()[:5]\n update = None\n update_user = None\n\n if update_id is not None:\n edit_mode = True\n update = get_object_or_404(ProjectUpdate, id=update_id)\n update_user = update.user.get_full_name()\n if not request.user == update.user and not request.user.can_edit_update(update):\n request.error_message = u'You can only edit your own updates.'\n raise PermissionDenied\n\n # Prevent adding update if project is completed, cancelled or unpublished\n elif project.iati_status in Project.EDIT_DISABLED or not project.is_published():\n request.error_message = u'Cannot add updates to completed or unpublished projects.'\n raise PermissionDenied\n\n if request.method == 'POST':\n updateform = form_class(request.POST, request.FILES, instance=update)\n if updateform.is_valid():\n if update:\n update = updateform.save(project=project, user=update.user)\n else:\n update = updateform.save(project=project, user=request.user)\n return redirect(update.get_absolute_url())\n else:\n # Django forms takes care of this, and displays the errors!\n pass\n else:\n updateform = form_class(instance=update)\n\n context = {\n 'project': project,\n 'updates': updates,\n 'update': update,\n 'update_user': update_user,\n 'updateform': updateform,\n 'edit_mode': edit_mode,\n 'allow_update': allow_update\n }\n\n return render(request, 'update_add.html', context)\n", "path": "akvo/rsr/views/project.py" } ]	diff --git a/akvo/rsr/tests/views/test_project.py b/akvo/rsr/tests/views/test_project.py index 9581530c89..7aeb31a7fd 100644 --- a/akvo/rsr/tests/views/test_project.py +++ b/akvo/rsr/tests/views/test_project.py @@ -15,7 +15,7 @@ from django.conf import settings from django.test import Client, TestCase -from akvo.rsr.models import Organisation +from akvo.rsr.models import Keyword, Organisation, PartnerSite, Partnership, Project @skip('Needs Django >= 1.8') @@ -84,3 +84,95 @@ def test_should_replace_page_size_limit_parameter(self): self.assertIn(page_limit_1, response.content) self.assertIn(page_limit_2, response.content) self.assertIn(page_limit_3, response.content) + + def test_should_show_keyword_projects_in_partner_site(self): + # Given + hostname = 'akvo' + partner_projects = False + org = Organisation.objects.create(name=hostname) + keyword = Keyword.objects.create(label=hostname) + partner_site = PartnerSite.objects.create( + hostname=hostname, + partner_projects=partner_projects, + organisation=org, + piwik_id=10, + ) + partner_site.keywords.add(keyword) + project_title = '{} awesome project'.format(hostname) + project = Project.objects.create(title=project_title) + project.keywords.add(keyword) + project.publishingstatus.status = 'published' + project.publishingstatus.save() + url = '/en/projects/' + self.c = Client(HTTP_HOST='{}.{}'.format(hostname, settings.AKVOAPP_DOMAIN)) + + # When + response = self.c.get(url, follow=True) + + # Then + self.assertIn(project_title, response.content) + + def test_should_show_all_partner_projects(self): + # Given + hostname = 'akvo' + partner_projects = True + org = Organisation.objects.create(name=hostname) + PartnerSite.objects.create( + hostname=hostname, + partner_projects=partner_projects, + organisation=org, + piwik_id=10, + ) + project_title1 = '{} awesome project {}'.format(hostname, 1) + project1 = Project.objects.create(title=project_title1) + project1.publishingstatus.status = 'published' + project1.publishingstatus.save() + Partnership.objects.create(organisation=org, project=project1) + project_title2 = '{} awesome project {}'.format(hostname, 2) + project2 = Project.objects.create(title=project_title2) + project2.publishingstatus.status = 'published' + project2.publishingstatus.save() + Partnership.objects.create(organisation=org, project=project2) + url = '/en/projects/' + self.c = Client(HTTP_HOST='{}.{}'.format(hostname, settings.AKVOAPP_DOMAIN)) + + # When + response = self.c.get(url, follow=True) + + # Then + self.assertIn(project_title1, response.content) + self.assertIn(project_title2, response.content) + + def test_should_show_partner_projects_with_keyword(self): + # Given + hostname = 'akvo' + partner_projects = True + org = Organisation.objects.create(name=hostname) + keyword = Keyword.objects.create(label=hostname) + partner_site = PartnerSite.objects.create( + hostname=hostname, + partner_projects=partner_projects, + organisation=org, + piwik_id=10, + ) + partner_site.keywords.add(keyword) + project_title1 = '{} awesome project {}'.format(hostname, 1) + project1 = Project.objects.create(title=project_title1) + project1.keywords.add(keyword) + project1.publishingstatus.status = 'published' + project1.publishingstatus.save() + Partnership.objects.create(organisation=org, project=project1) + project_title2 = '{} awesome project {}'.format(hostname, 2) + project2 = Project.objects.create(title=project_title2) + project2.publishingstatus.status = 'published' + project2.publishingstatus.save() + Partnership.objects.create(organisation=org, project=project2) + url = '/en/projects/' + self.c = Client(HTTP_HOST='{}.{}'.format(hostname, settings.AKVOAPP_DOMAIN)) + + # When + response = self.c.get(url, follow=True) + + # Then + self.assertIn(project_title1, response.content) + self.assertNotIn(project_title2, response.content) diff --git a/akvo/rsr/views/project.py b/akvo/rsr/views/project.py index 1f84bab705..ae7bdbdcd4 100644 --- a/akvo/rsr/views/project.py +++ b/akvo/rsr/views/project.py @@ -40,7 +40,7 @@ def _project_directory_coll(request): """Dig out and pass correct projects to the view.""" page = request.rsr_page return ( - page.organisation.published_projects() if page is not None + page.projects() if page is not None else Project.objects.public().published() )
rucio__rucio-2776	Account and Scope new types Motivation ---------- For multi-vo the internal representation of scope and account will need to be different from the external representation. The translations for these should be done in a consistent way and this can be prepared beforehand. Modification ------------ Create a new type for each of scope and account. Convert incoming account names and scopes to these types in the API directory so that multi-vo changes are more straight forward. If normal strings are used in core, raise an error.	[ { "content": "\n'''\nThis file is automatically generated; Do not edit it. :)\n'''\nVERSION_INFO = {\n 'final': True,\n 'version': '1.20.3',\n 'branch_nick': 'patch-0-Release__Rucio_1_20_3_preparation',\n 'revision_id': 'f05e019f7178590718bf3f1eee415cc46cb59159',\n 'revno': 8410\n}\n", "path": "lib/rucio/vcsversion.py" } ]	[ { "content": "\n'''\nThis file is automatically generated; Do not edit it. :)\n'''\nVERSION_INFO = {\n 'final': True,\n 'version': '1.20.4rc1',\n 'branch_nick': 'patch-0-Release__1_20_4rc1_preparation',\n 'revision_id': '525812b8f83f1069d38ab78aebedb732f21e77ec',\n 'revno': 8418\n}\n", "path": "lib/rucio/vcsversion.py" } ]	diff --git a/doc/source/releasenotes/1.20.4rc1.rst b/doc/source/releasenotes/1.20.4rc1.rst new file mode 100644 index 0000000000..4be3659cb5 --- /dev/null +++ b/doc/source/releasenotes/1.20.4rc1.rst @@ -0,0 +1,20 @@ +========= +1.20.4rc1 +========= + +------- +General +------- + +********** +Enhancements +******** + +- Core & Internals: Account and Scope new types `#2553 <https://github.com/rucio/rucio/issues/2553>`_ + + +Bugs +** + +- Consistency checks: Dark Reaper rse_id crash `#2760 <https://github.com/rucio/rucio/issues/2760>`_ +- RSE Manager: Parent directory creation with gfal `#2754 <https://github.com/rucio/rucio/issues/2754>`_ diff --git a/lib/rucio/vcsversion.py b/lib/rucio/vcsversion.py index ce7aba685f..248b5da866 100644 --- a/lib/rucio/vcsversion.py +++ b/lib/rucio/vcsversion.py @@ -4,8 +4,8 @@ ''' VERSION_INFO = { 'final': True, - 'version': '1.20.3', - 'branch_nick': 'patch-0-Release__Rucio_1_20_3_preparation', - 'revision_id': 'f05e019f7178590718bf3f1eee415cc46cb59159', - 'revno': 8410 + 'version': '1.20.4rc1', + 'branch_nick': 'patch-0-Release__1_20_4rc1_preparation', + 'revision_id': '525812b8f83f1069d38ab78aebedb732f21e77ec', + 'revno': 8418 } diff --git a/lib/rucio/web/ui/static/webui_version b/lib/rucio/web/ui/static/webui_version index 3cb1511de6..0a4beb618c 100644 --- a/lib/rucio/web/ui/static/webui_version +++ b/lib/rucio/web/ui/static/webui_version @@ -1 +1 @@ -1.20.3 \ No newline at end of file +1.20.4rc1 \ No newline at end of file
dotkom__onlineweb4-165	Adding 'Offline Informasjonstekster' causes error Not really sure what this does but it casts an error saying: Exception Type: IntegrityError Exception Value: column key is not unique	[ { "content": "from apps.offline.models import ProxyChunk, Issue\nfrom chunks.models import Chunk\nfrom django.contrib import admin\nfrom django.db.models import Q\n\n\nclass ProxyChunkAdmin(admin.ModelAdmin):\n\n readonly_fields = ['key']\n\n def queryset(self, request):\n offline = Chunk.objects.filter(Q(key='offline_ingress') \| Q(key='offline_brodtekst'))\n return offline\n\nadmin.site.register(ProxyChunk, ProxyChunkAdmin)\nadmin.site.register(Issue)\n", "path": "apps/offline/admin.py" } ]	[ { "content": "from apps.offline.models import ProxyChunk, Issue\nfrom chunks.models import Chunk\nfrom django.contrib import admin\nfrom django.db.models import Q\n\n\nclass ProxyChunkAdmin(admin.ModelAdmin):\n\n readonly_fields = ['key']\n\n def has_add_permission(self, request):\n return False\n\n def queryset(self, request):\n offline = Chunk.objects.filter(Q(key='offline_ingress') \| Q(key='offline_brodtekst'))\n return offline\n\nadmin.site.register(ProxyChunk, ProxyChunkAdmin)\nadmin.site.register(Issue)\n", "path": "apps/offline/admin.py" } ]	diff --git a/apps/offline/admin.py b/apps/offline/admin.py index c4fc6e020..8ec805833 100644 --- a/apps/offline/admin.py +++ b/apps/offline/admin.py @@ -8,6 +8,9 @@ class ProxyChunkAdmin(admin.ModelAdmin): readonly_fields = ['key'] + def has_add_permission(self, request): + return False + def queryset(self, request): offline = Chunk.objects.filter(Q(key='offline_ingress') \| Q(key='offline_brodtekst')) return offline
PyGithub__PyGithub-2460	401 unauthorized after upgrading to 1.58.0 We use `GithubIntegration.get_access_token` to authenticate and after upgrading we now get this response: ``` github.GithubException.GithubException: 401 {"message": "'Expiration time' claim ('exp') must be a numeric value representing the future time at which the assertion expires", "documentation_url": "https://docs.github.com/rest"} ``` Reverting to 1.57 solves the issue.	[ { "content": "import time\n\nimport deprecated\nimport jwt\n\nfrom github import Consts\nfrom github.GithubException import GithubException\nfrom github.Installation import Installation\nfrom github.InstallationAuthorization import InstallationAuthorization\nfrom github.PaginatedList import PaginatedList\nfrom github.Requester import Requester\n\n\nclass GithubIntegration:\n \"\"\"\n Main class to obtain tokens for a GitHub integration.\n \"\"\"\n\n def __init__(\n self,\n integration_id,\n private_key,\n base_url=Consts.DEFAULT_BASE_URL,\n jwt_expiry=Consts.DEFAULT_JWT_EXPIRY,\n jwt_issued_at=Consts.DEFAULT_JWT_ISSUED_AT,\n ):\n \"\"\"\n :param integration_id: int\n :param private_key: string\n :param base_url: string\n :param jwt_expiry: int. Expiry of the JWT used to get the information about this integration.\n The default expiration is in 5 minutes and is capped at 10 minutes according to GitHub documentation\n https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-json-web-token-jwt\n :param jwt_issued_at: int. Number of seconds, relative to now, to set for the \"iat\" (issued at) parameter.\n The default value is -60 to protect against clock drift\n \"\"\"\n assert isinstance(integration_id, (int, str)), integration_id\n assert isinstance(private_key, str), \"supplied private key should be a string\"\n assert isinstance(base_url, str), base_url\n assert isinstance(jwt_expiry, int), jwt_expiry\n assert Consts.MIN_JWT_EXPIRY <= jwt_expiry <= Consts.MAX_JWT_EXPIRY, jwt_expiry\n assert isinstance(jwt_issued_at, int)\n\n self.base_url = base_url\n self.integration_id = integration_id\n self.private_key = private_key\n self.jwt_expiry = jwt_expiry\n self.jwt_issued_at = jwt_issued_at\n self.__requester = Requester(\n login_or_token=None,\n password=None,\n jwt=self.create_jwt(),\n app_auth=None,\n base_url=self.base_url,\n timeout=Consts.DEFAULT_TIMEOUT,\n user_agent=\"PyGithub/Python\",\n per_page=Consts.DEFAULT_PER_PAGE,\n verify=True,\n retry=None,\n pool_size=None,\n )\n\n def _get_headers(self):\n \"\"\"\n Get headers for the requests.\n\n :return: dict\n \"\"\"\n return {\n \"Authorization\": f\"Bearer {self.create_jwt()}\",\n \"Accept\": Consts.mediaTypeIntegrationPreview,\n \"User-Agent\": \"PyGithub/Python\",\n }\n\n def _get_installed_app(self, url):\n \"\"\"\n Get installation for the given URL.\n\n :param url: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n headers, response = self.__requester.requestJsonAndCheck(\n \"GET\", url, headers=self._get_headers()\n )\n\n return Installation(\n requester=self.__requester,\n headers=headers,\n attributes=response,\n completed=True,\n )\n\n def create_jwt(self, expiration=None):\n \"\"\"\n Create a signed JWT\n https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app\n\n :return string:\n \"\"\"\n if expiration is not None:\n assert isinstance(expiration, int), expiration\n assert (\n Consts.MIN_JWT_EXPIRY <= expiration <= Consts.MAX_JWT_EXPIRY\n ), expiration\n\n now = int(time.time())\n payload = {\n \"iat\": now + self.jwt_issued_at,\n \"exp\": now + (expiration if expiration is not None else self.jwt_expiry),\n \"iss\": self.integration_id,\n }\n encrypted = jwt.encode(payload, key=self.private_key, algorithm=\"RS256\")\n\n if isinstance(encrypted, bytes):\n encrypted = encrypted.decode(\"utf-8\")\n\n return encrypted\n\n def get_access_token(self, installation_id, permissions=None):\n \"\"\"\n :calls: `POST /app/installations/{installation_id}/access_tokens <https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app>`\n :param installation_id: int\n :param permissions: dict\n :return: :class:`github.InstallationAuthorization.InstallationAuthorization`\n \"\"\"\n if permissions is None:\n permissions = {}\n\n if not isinstance(permissions, dict):\n raise GithubException(\n status=400, data={\"message\": \"Invalid permissions\"}, headers=None\n )\n\n body = {\"permissions\": permissions}\n headers, response = self.__requester.requestJsonAndCheck(\n \"POST\",\n f\"/app/installations/{installation_id}/access_tokens\",\n input=body,\n )\n\n return InstallationAuthorization(\n requester=self.__requester,\n headers=headers,\n attributes=response,\n completed=True,\n )\n\n @deprecated.deprecated(\"Use get_repo_installation\")\n def get_installation(self, owner, repo):\n \"\"\"\n Deprecated by get_repo_installation\n\n :calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app>`\n :param owner: str\n :param repo: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/repos/{owner}/{repo}/installation\")\n\n def get_installations(self):\n \"\"\"\n :calls: GET /app/installations <https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app>\n :rtype: :class:`github.PaginatedList.PaginatedList[github.Installation.Installation]`\n \"\"\"\n return PaginatedList(\n contentClass=Installation,\n requester=self.__requester,\n firstUrl=\"/app/installations\",\n firstParams=None,\n headers=self._get_headers(),\n list_item=\"installations\",\n )\n\n def get_org_installation(self, org):\n \"\"\"\n :calls: `GET /orgs/{org}/installation <https://docs.github.com/en/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app>`\n :param org: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/orgs/{org}/installation\")\n\n def get_repo_installation(self, owner, repo):\n \"\"\"\n :calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app>`\n :param owner: str\n :param repo: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/repos/{owner}/{repo}/installation\")\n\n def get_user_installation(self, username):\n \"\"\"\n :calls: `GET /users/{username}/installation <https://docs.github.com/en/rest/apps/apps#get-a-user-installation-for-the-authenticated-app>`\n :param username: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/users/{username}/installation\")\n\n def get_app_installation(self, installation_id):\n \"\"\"\n :calls: `GET /app/installations/{installation_id} <https://docs.github.com/en/rest/apps/apps#get-an-installation-for-the-authenticated-app>`\n :param installation_id: int\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/app/installations/{installation_id}\")\n", "path": "github/GithubIntegration.py" } ]	[ { "content": "import time\n\nimport deprecated\nimport jwt\n\nfrom github import Consts\nfrom github.GithubException import GithubException\nfrom github.Installation import Installation\nfrom github.InstallationAuthorization import InstallationAuthorization\nfrom github.PaginatedList import PaginatedList\nfrom github.Requester import Requester\n\n\nclass GithubIntegration:\n \"\"\"\n Main class to obtain tokens for a GitHub integration.\n \"\"\"\n\n def __init__(\n self,\n integration_id,\n private_key,\n base_url=Consts.DEFAULT_BASE_URL,\n jwt_expiry=Consts.DEFAULT_JWT_EXPIRY,\n jwt_issued_at=Consts.DEFAULT_JWT_ISSUED_AT,\n ):\n \"\"\"\n :param integration_id: int\n :param private_key: string\n :param base_url: string\n :param jwt_expiry: int. Expiry of the JWT used to get the information about this integration.\n The default expiration is in 5 minutes and is capped at 10 minutes according to GitHub documentation\n https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#generating-a-json-web-token-jwt\n :param jwt_issued_at: int. Number of seconds, relative to now, to set for the \"iat\" (issued at) parameter.\n The default value is -60 to protect against clock drift\n \"\"\"\n assert isinstance(integration_id, (int, str)), integration_id\n assert isinstance(private_key, str), \"supplied private key should be a string\"\n assert isinstance(base_url, str), base_url\n assert isinstance(jwt_expiry, int), jwt_expiry\n assert Consts.MIN_JWT_EXPIRY <= jwt_expiry <= Consts.MAX_JWT_EXPIRY, jwt_expiry\n assert isinstance(jwt_issued_at, int)\n\n self.base_url = base_url\n self.integration_id = integration_id\n self.private_key = private_key\n self.jwt_expiry = jwt_expiry\n self.jwt_issued_at = jwt_issued_at\n self.__requester = Requester(\n login_or_token=None,\n password=None,\n jwt=self.create_jwt(),\n app_auth=None,\n base_url=self.base_url,\n timeout=Consts.DEFAULT_TIMEOUT,\n user_agent=\"PyGithub/Python\",\n per_page=Consts.DEFAULT_PER_PAGE,\n verify=True,\n retry=None,\n pool_size=None,\n )\n\n def _get_headers(self):\n \"\"\"\n Get headers for the requests.\n\n :return: dict\n \"\"\"\n return {\n \"Authorization\": f\"Bearer {self.create_jwt()}\",\n \"Accept\": Consts.mediaTypeIntegrationPreview,\n \"User-Agent\": \"PyGithub/Python\",\n }\n\n def _get_installed_app(self, url):\n \"\"\"\n Get installation for the given URL.\n\n :param url: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n headers, response = self.__requester.requestJsonAndCheck(\n \"GET\", url, headers=self._get_headers()\n )\n\n return Installation(\n requester=self.__requester,\n headers=headers,\n attributes=response,\n completed=True,\n )\n\n def create_jwt(self, expiration=None):\n \"\"\"\n Create a signed JWT\n https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app\n\n :return string:\n \"\"\"\n if expiration is not None:\n assert isinstance(expiration, int), expiration\n assert (\n Consts.MIN_JWT_EXPIRY <= expiration <= Consts.MAX_JWT_EXPIRY\n ), expiration\n\n now = int(time.time())\n payload = {\n \"iat\": now + self.jwt_issued_at,\n \"exp\": now + (expiration if expiration is not None else self.jwt_expiry),\n \"iss\": self.integration_id,\n }\n encrypted = jwt.encode(payload, key=self.private_key, algorithm=\"RS256\")\n\n if isinstance(encrypted, bytes):\n encrypted = encrypted.decode(\"utf-8\")\n\n return encrypted\n\n def get_access_token(self, installation_id, permissions=None):\n \"\"\"\n :calls: `POST /app/installations/{installation_id}/access_tokens <https://docs.github.com/en/rest/apps/apps#create-an-installation-access-token-for-an-app>`\n :param installation_id: int\n :param permissions: dict\n :return: :class:`github.InstallationAuthorization.InstallationAuthorization`\n \"\"\"\n if permissions is None:\n permissions = {}\n\n if not isinstance(permissions, dict):\n raise GithubException(\n status=400, data={\"message\": \"Invalid permissions\"}, headers=None\n )\n\n body = {\"permissions\": permissions}\n headers, response = self.__requester.requestJsonAndCheck(\n \"POST\",\n f\"/app/installations/{installation_id}/access_tokens\",\n headers=self._get_headers(),\n input=body,\n )\n\n return InstallationAuthorization(\n requester=self.__requester,\n headers=headers,\n attributes=response,\n completed=True,\n )\n\n @deprecated.deprecated(\"Use get_repo_installation\")\n def get_installation(self, owner, repo):\n \"\"\"\n Deprecated by get_repo_installation\n\n :calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app>`\n :param owner: str\n :param repo: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/repos/{owner}/{repo}/installation\")\n\n def get_installations(self):\n \"\"\"\n :calls: GET /app/installations <https://docs.github.com/en/rest/reference/apps#list-installations-for-the-authenticated-app>\n :rtype: :class:`github.PaginatedList.PaginatedList[github.Installation.Installation]`\n \"\"\"\n return PaginatedList(\n contentClass=Installation,\n requester=self.__requester,\n firstUrl=\"/app/installations\",\n firstParams=None,\n headers=self._get_headers(),\n list_item=\"installations\",\n )\n\n def get_org_installation(self, org):\n \"\"\"\n :calls: `GET /orgs/{org}/installation <https://docs.github.com/en/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app>`\n :param org: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/orgs/{org}/installation\")\n\n def get_repo_installation(self, owner, repo):\n \"\"\"\n :calls: `GET /repos/{owner}/{repo}/installation <https://docs.github.com/en/rest/reference/apps#get-a-repository-installation-for-the-authenticated-app>`\n :param owner: str\n :param repo: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/repos/{owner}/{repo}/installation\")\n\n def get_user_installation(self, username):\n \"\"\"\n :calls: `GET /users/{username}/installation <https://docs.github.com/en/rest/apps/apps#get-a-user-installation-for-the-authenticated-app>`\n :param username: str\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/users/{username}/installation\")\n\n def get_app_installation(self, installation_id):\n \"\"\"\n :calls: `GET /app/installations/{installation_id} <https://docs.github.com/en/rest/apps/apps#get-an-installation-for-the-authenticated-app>`\n :param installation_id: int\n :rtype: :class:`github.Installation.Installation`\n \"\"\"\n return self._get_installed_app(url=f\"/app/installations/{installation_id}\")\n", "path": "github/GithubIntegration.py" } ]	diff --git a/github/GithubIntegration.py b/github/GithubIntegration.py index 82c85bc9c2..475a6c0f7a 100644 --- a/github/GithubIntegration.py +++ b/github/GithubIntegration.py @@ -135,6 +135,7 @@ def get_access_token(self, installation_id, permissions=None): headers, response = self.__requester.requestJsonAndCheck( "POST", f"/app/installations/{installation_id}/access_tokens", + headers=self._get_headers(), input=body, ) diff --git a/tests/ReplayData/Authentication.testAppAuthentication.txt b/tests/ReplayData/Authentication.testAppAuthentication.txt index 53391560e5..9f2a6b2e87 100644 --- a/tests/ReplayData/Authentication.testAppAuthentication.txt +++ b/tests/ReplayData/Authentication.testAppAuthentication.txt @@ -3,7 +3,7 @@ POST api.github.com None /app/installations/29782936/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 201 [('status', '201 CREATED'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] diff --git a/tests/ReplayData/GithubIntegration.testGetAccessToken.txt b/tests/ReplayData/GithubIntegration.testGetAccessToken.txt index 4f37651d02..a59fe84631 100644 --- a/tests/ReplayData/GithubIntegration.testGetAccessToken.txt +++ b/tests/ReplayData/GithubIntegration.testGetAccessToken.txt @@ -3,7 +3,7 @@ POST api.github.com None /app/installations/30614431/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 201 [('status', '201 CREATED'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] @@ -14,7 +14,7 @@ POST api.github.com None /app/installations/30614487/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 201 [('status', '201 CREATED'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] @@ -25,7 +25,7 @@ POST api.github.com None /app/installations/30614431/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 201 [('status', '201 CREATED'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] diff --git a/tests/ReplayData/GithubIntegration.testGetAccessTokenForNoInstallation.txt b/tests/ReplayData/GithubIntegration.testGetAccessTokenForNoInstallation.txt index db1f2cb827..885a873697 100644 --- a/tests/ReplayData/GithubIntegration.testGetAccessTokenForNoInstallation.txt +++ b/tests/ReplayData/GithubIntegration.testGetAccessTokenForNoInstallation.txt @@ -3,7 +3,7 @@ POST api.github.com None /app/installations/40432121/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 404 [('status', '404 NOT FOUND'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', '"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] diff --git a/tests/ReplayData/GithubIntegration.testGetAccessTokenWithExpiredJWT.txt b/tests/ReplayData/GithubIntegration.testGetAccessTokenWithExpiredJWT.txt index 0ce4c84770..a0dec1f65a 100644 --- a/tests/ReplayData/GithubIntegration.testGetAccessTokenWithExpiredJWT.txt +++ b/tests/ReplayData/GithubIntegration.testGetAccessTokenWithExpiredJWT.txt @@ -3,7 +3,7 @@ POST api.github.com None /app/installations/30614431/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {}} 401 [('status', '401 UNAUTHORIZED'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', ''), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")] diff --git a/tests/ReplayData/GithubIntegration.testGetAccessTokenWithInvalidPermissions.txt b/tests/ReplayData/GithubIntegration.testGetAccessTokenWithInvalidPermissions.txt index a9b790c55e..216ece9113 100644 --- a/tests/ReplayData/GithubIntegration.testGetAccessTokenWithInvalidPermissions.txt +++ b/tests/ReplayData/GithubIntegration.testGetAccessTokenWithInvalidPermissions.txt @@ -3,7 +3,7 @@ POST api.github.com None /app/installations/30614431/access_tokens -{'Authorization': 'Bearer jwt_removed', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} +{'Authorization': 'Bearer jwt_removed', 'Accept': 'application/vnd.github.machine-man-preview+json', 'User-Agent': 'PyGithub/Python', 'Content-Type': 'application/json'} {"permissions": {"test-permissions": "read"}} 422 [('status', '422 UNPROCESSABLE ENTITY'), ('server', 'Github.com'), ('date', 'Mon, 24 Oct 2022 23:11:45 GMT'), ('content-type', 'application/json; charset=utf-8'), ('connection', 'keep-alive'), ('content-length', '1962'), ('etag', 'W/"b11a1c9caabe35f1de0a13e597a3022d27d2bff0694c2ccb5a65edc3b4d18837"'), ('cache-control', 'public, max-age=60, s-maxage=60'), ('vary', 'Accept'), ('x-github-media-type', 'github.v3; format=json'), ('access-control-expose-headers', 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Used, X-RateLimit-Resource, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, X-GitHub-SSO, X-GitHub-Request-Id, Deprecation, Sunset'), ('access-control-allow-origin', '*'), ('strict-transport-security', 'max-age=31536000; includeSubdomains; preload'), ('x-frame-options', 'deny'), ('x-content-type-options', 'nosniff'), ('x-xss-protection', '0'), ('referrer-policy', 'origin-when-cross-origin, strict-origin-when-cross-origin'), ('x-github-request-id', "E475:53DD:8B7A89E:11E38A79:63571BB0"), ('vary', 'Accept-Encoding, Accept, X-Requested-With'), ('content-security-policy', "default-src 'none'")]
cobbler__cobbler-3292	Cobbler modules don't load properly ### Describe the bug Introduced in https://github.com/cobbler/cobbler/commit/2477c78094af7ba44ecbe350294c775296d96560 ### Steps to reproduce 1. Import any Cobbler Module 2. See import error ### Expected behavior Bug not present ### Cobbler version ````paste below ```` ### Operating system openSUSE Tumbleweed ### Cobbler log ````paste below ```` ### Screenshots None ### Additional information None	[ { "content": "\"\"\"\nModule loader, adapted for Cobbler usage\n\"\"\"\n\n# SPDX-License-Identifier: GPL-2.0-or-later\n# SPDX-FileCopyrightText: Copyright 2006-2009, Red Hat, Inc and Others\n# SPDX-FileCopyrightText: Adrian Likins <[email protected]>\n# SPDX-FileCopyrightText: Michael DeHaan <michael.dehaan AT gmail>\n\nimport logging\nfrom importlib import import_module\n\nimport glob\nimport os\nfrom typing import Optional, Dict, Any\n\nfrom cobbler.cexceptions import CX\nfrom cobbler.utils import log_exc\n\n# add cobbler/modules to python path\nimport cobbler\n\n\nclass ModuleLoader:\n \"\"\"\n Class for dynamically loading Cobbler Plugins on startup\n \"\"\"\n\n def __init__(self, api, module_path: str = \"\"):\n \"\"\"\n Constructor to initialize the ModuleLoader class.\n\n :param api: CobblerAPI\n :param module_path: The path which should be considered as the root module path. If this an empty string, try to\n auto-detect the path.\n \"\"\"\n self.logger = logging.getLogger()\n self.mod_path = os.path.join(\n os.path.abspath(os.path.dirname(cobbler.__file__)), \"modules\"\n )\n if module_path:\n self.mod_path = module_path\n self.module_cache: Dict[str, Any] = {}\n self.modules_by_category: Dict[str, Dict[str, Any]] = {}\n self.api = api\n\n def load_modules(self):\n \"\"\"\n Load the modules from the path handed to the function into Cobbler.\n\n :return: Two dictionary's with the dynamically loaded modules.\n \"\"\"\n\n filenames = glob.glob(f\"{self.mod_path}/.py\")\n filenames += glob.glob(f\"{self.mod_path}/.pyc\")\n filenames += glob.glob(f\"{self.mod_path}/.pyo\")\n # Allow recursive modules\n filenames += glob.glob(f\"{self.mod_path}//.py\")\n filenames += glob.glob(f\"{self.mod_path}/*/.pyc\")\n filenames += glob.glob(f\"{self.mod_path}/*/.pyo\")\n\n for filename in filenames:\n basename = filename.replace(self.mod_path, \"\")\n modname = \"\"\n\n if basename in (\"__pycache__\", \"__init__.py\"):\n continue\n\n if basename[0] == \"/\":\n basename = basename[1:]\n\n basename = basename.replace(\"/\", \".\")\n\n if basename[-3:] == \".py\":\n modname = basename[:-3]\n elif basename[-4:] in [\".pyc\", \".pyo\"]:\n modname = basename[:-4]\n\n self.__import_module(modname)\n\n return self.module_cache, self.modules_by_category\n\n def __import_module(self, modname: str):\n \"\"\"\n Import a module which is not part of the core functionality of Cobbler.\n\n :param modname: The name of the module.\n \"\"\"\n try:\n blip = import_module(f\"cobbler.modules.{modname}\")\n if not hasattr(blip, \"register\"):\n self.logger.debug(\n \"%s.%s is not a proper module\", self.mod_path, modname\n )\n return None\n category = blip.register()\n if category:\n self.module_cache[modname] = blip\n if category not in self.modules_by_category:\n self.modules_by_category[category] = {}\n self.modules_by_category[category][modname] = blip\n except Exception:\n self.logger.info(\"Exception raised when loading module %s\", modname)\n log_exc()\n\n def get_module_by_name(self, name: str):\n \"\"\"\n Get a module by its name. The category of the module is not needed.\n\n :param name: The name of the module.\n :return: The module asked by the function parameter.\n \"\"\"\n return self.module_cache.get(name, None)\n\n def get_module_name(\n self, category: str, field: str, fallback_module_name: Optional[str] = None\n ) -> str:\n \"\"\"\n Get module name from the settings.\n\n :param category: Field category in configuration file.\n :param field: Field in configuration file\n :param fallback_module_name: Default value used if category/field is not found in configuration file\n :raises FileNotFoundError: If unable to find configuration file.\n :raises ValueError: If the category does not exist or the field is empty.\n :raises CX: If the field could not be read and no fallback_module_name was given.\n :returns: The name of the module.\n \"\"\"\n # FIXME: We can't enabled this check since it is to strict atm.\n # if category not in MODULES_BY_CATEGORY:\n # raise ValueError(\"category must be one of: %s\" % MODULES_BY_CATEGORY.keys())\n\n if field.isspace():\n raise ValueError('field cannot be empty. Did you mean \"module\" maybe?')\n\n try:\n value = self.api.settings().modules.get(category, {}).get(\"module\")\n if value is None:\n raise ModuleNotFoundError(\"Requested module could not be retrieved\")\n except Exception as exception:\n if fallback_module_name is None:\n raise CX(\n f\"Cannot find config file setting for: {category}.{field}\"\n ) from exception\n value = fallback_module_name\n self.logger.warning(\n 'Requested module \"%s.%s\" not found. Using fallback module: \"%s\"',\n category,\n field,\n value,\n )\n return value\n\n def get_module_from_file(\n self, category: str, field: str, fallback_module_name: Optional[str] = None\n ):\n \"\"\"\n Get Python module, based on name defined in configuration file\n\n :param category: field category in configuration file\n :param field: field in configuration file\n :param fallback_module_name: default value used if category/field is not found in configuration file\n :raises CX: If unable to load Python module\n :returns: A Python module.\n \"\"\"\n\n module_name = self.get_module_name(category, field, fallback_module_name)\n requested_module = self.module_cache.get(module_name, None)\n if requested_module is None:\n raise CX(f\"Failed to load module for {category}.{field}\")\n return requested_module\n\n def get_modules_in_category(self, category: str) -> list:\n \"\"\"\n Return all modules of a module category.\n\n :param category: The module category.\n :return: A list of all modules of that category. Returns an empty list if the Category does not exist.\n \"\"\"\n if category not in self.modules_by_category:\n # FIXME: We can't enabled this check since it is to strict atm.\n # raise ValueError(\"category must be one of: %s\" % MODULES_BY_CATEGORY.keys())\n return []\n return list(self.modules_by_category[category].values())\n", "path": "cobbler/module_loader.py" } ]	[ { "content": "\"\"\"\nModule loader, adapted for Cobbler usage\n\"\"\"\n\n# SPDX-License-Identifier: GPL-2.0-or-later\n# SPDX-FileCopyrightText: Copyright 2006-2009, Red Hat, Inc and Others\n# SPDX-FileCopyrightText: Adrian Likins <[email protected]>\n# SPDX-FileCopyrightText: Michael DeHaan <michael.dehaan AT gmail>\n\nimport logging\nfrom importlib import import_module\n\nimport glob\nimport os\nfrom typing import Optional, Dict, Any\n\nfrom cobbler.cexceptions import CX\nfrom cobbler.utils import log_exc\n\n# add cobbler/modules to python path\nimport cobbler\n\n\nclass ModuleLoader:\n \"\"\"\n Class for dynamically loading Cobbler Plugins on startup\n \"\"\"\n\n def __init__(self, api, module_path: str = \"\"):\n \"\"\"\n Constructor to initialize the ModuleLoader class.\n\n :param api: CobblerAPI\n :param module_path: The path which should be considered as the root module path. If this an empty string, try to\n auto-detect the path.\n \"\"\"\n self.logger = logging.getLogger()\n self.mod_path = os.path.join(\n os.path.abspath(os.path.dirname(cobbler.__file__)), \"modules\"\n )\n if module_path:\n self.mod_path = module_path\n self.module_cache: Dict[str, Any] = {}\n self.modules_by_category: Dict[str, Dict[str, Any]] = {}\n self.api = api\n\n def load_modules(self):\n \"\"\"\n Load the modules from the path handed to the function into Cobbler.\n\n :return: Two dictionary's with the dynamically loaded modules.\n \"\"\"\n\n filenames = glob.glob(f\"{self.mod_path}/.py\")\n filenames += glob.glob(f\"{self.mod_path}/.pyc\")\n filenames += glob.glob(f\"{self.mod_path}/.pyo\")\n # Allow recursive modules\n filenames += glob.glob(f\"{self.mod_path}//.py\")\n filenames += glob.glob(f\"{self.mod_path}/*/.pyc\")\n filenames += glob.glob(f\"{self.mod_path}/*/.pyo\")\n\n for filename in filenames:\n basename = filename.replace(self.mod_path, \"\")\n modname = \"\"\n\n if \"__pycache__\" in basename or \"__init__.py\" in basename:\n continue\n\n if basename[0] == \"/\":\n basename = basename[1:]\n\n basename = basename.replace(\"/\", \".\")\n\n if basename[-3:] == \".py\":\n modname = basename[:-3]\n elif basename[-4:] in [\".pyc\", \".pyo\"]:\n modname = basename[:-4]\n\n self.__import_module(modname)\n\n return self.module_cache, self.modules_by_category\n\n def __import_module(self, modname: str):\n \"\"\"\n Import a module which is not part of the core functionality of Cobbler.\n\n :param modname: The name of the module.\n \"\"\"\n try:\n blip = import_module(f\"cobbler.modules.{modname}\")\n if not hasattr(blip, \"register\"):\n self.logger.debug(\n \"%s.%s is not a proper module\", self.mod_path, modname\n )\n return None\n category = blip.register()\n if category:\n self.module_cache[modname] = blip\n if category not in self.modules_by_category:\n self.modules_by_category[category] = {}\n self.modules_by_category[category][modname] = blip\n except Exception:\n self.logger.info(\"Exception raised when loading module %s\", modname)\n log_exc()\n\n def get_module_by_name(self, name: str):\n \"\"\"\n Get a module by its name. The category of the module is not needed.\n\n :param name: The name of the module.\n :return: The module asked by the function parameter.\n \"\"\"\n return self.module_cache.get(name, None)\n\n def get_module_name(\n self, category: str, field: str, fallback_module_name: Optional[str] = None\n ) -> str:\n \"\"\"\n Get module name from the settings.\n\n :param category: Field category in configuration file.\n :param field: Field in configuration file\n :param fallback_module_name: Default value used if category/field is not found in configuration file\n :raises FileNotFoundError: If unable to find configuration file.\n :raises ValueError: If the category does not exist or the field is empty.\n :raises CX: If the field could not be read and no fallback_module_name was given.\n :returns: The name of the module.\n \"\"\"\n # FIXME: We can't enabled this check since it is to strict atm.\n # if category not in MODULES_BY_CATEGORY:\n # raise ValueError(\"category must be one of: %s\" % MODULES_BY_CATEGORY.keys())\n\n if field.isspace():\n raise ValueError('field cannot be empty. Did you mean \"module\" maybe?')\n\n try:\n value = self.api.settings().modules.get(category, {}).get(\"module\")\n if value is None:\n raise ModuleNotFoundError(\"Requested module could not be retrieved\")\n except Exception as exception:\n if fallback_module_name is None:\n raise CX(\n f\"Cannot find config file setting for: {category}.{field}\"\n ) from exception\n value = fallback_module_name\n self.logger.warning(\n 'Requested module \"%s.%s\" not found. Using fallback module: \"%s\"',\n category,\n field,\n value,\n )\n return value\n\n def get_module_from_file(\n self, category: str, field: str, fallback_module_name: Optional[str] = None\n ):\n \"\"\"\n Get Python module, based on name defined in configuration file\n\n :param category: field category in configuration file\n :param field: field in configuration file\n :param fallback_module_name: default value used if category/field is not found in configuration file\n :raises CX: If unable to load Python module\n :returns: A Python module.\n \"\"\"\n\n module_name = self.get_module_name(category, field, fallback_module_name)\n requested_module = self.module_cache.get(module_name, None)\n if requested_module is None:\n raise CX(f\"Failed to load module for {category}.{field}\")\n return requested_module\n\n def get_modules_in_category(self, category: str) -> list:\n \"\"\"\n Return all modules of a module category.\n\n :param category: The module category.\n :return: A list of all modules of that category. Returns an empty list if the Category does not exist.\n \"\"\"\n if category not in self.modules_by_category:\n # FIXME: We can't enabled this check since it is to strict atm.\n # raise ValueError(\"category must be one of: %s\" % MODULES_BY_CATEGORY.keys())\n return []\n return list(self.modules_by_category[category].values())\n", "path": "cobbler/module_loader.py" } ]	diff --git a/cobbler/module_loader.py b/cobbler/module_loader.py index 88765c3094..801223cf41 100644 --- a/cobbler/module_loader.py +++ b/cobbler/module_loader.py @@ -63,7 +63,7 @@ def load_modules(self): basename = filename.replace(self.mod_path, "") modname = "" - if basename in ("__pycache__", "__init__.py"): + if "__pycache__" in basename or "__init__.py" in basename: continue if basename[0] == "/":
django-oscar__django-oscar-2130	Broken sandbox gateway page The README states that dashboard users for the sandbox site could be created using [this gateway page](http://latest.oscarcommerce.com/gateway/) - however this link returns a django error page: ``` TemplateDoesNotExist at /de/gateway/ gateway/form.html ```	[ { "content": "import os\n\nimport oscar\n\n# Path helper\nlocation = lambda x: os.path.join(\n os.path.dirname(os.path.realpath(__file__)), x)\n\nDEBUG = os.environ.get('DEBUG', 'true') != 'false'\nSQL_DEBUG = DEBUG\n\nALLOWED_HOSTS = [\n 'latest.oscarcommerce.com',\n 'master.oscarcommerce.com'\n]\n\n# This is needed for the hosted version of the sandbox\nADMINS = (\n ('David Winterbottom', '[email protected]'),\n ('Michael van Tellingen', '[email protected]'),\n)\nEMAIL_SUBJECT_PREFIX = '[Oscar sandbox] '\nEMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'\n\nMANAGERS = ADMINS\n\n# Use a Sqlite database by default\nDATABASES = {\n 'default': {\n 'ENGINE': os.environ.get('DATABASE_ENGINE', 'django.db.backends.sqlite3'),\n 'NAME': os.environ.get('DATABASE_NAME', location('db.sqlite')),\n 'USER': os.environ.get('DATABASE_USER', None),\n 'PASSWORD': os.environ.get('DATABASE_PASSWORD', None),\n 'HOST': os.environ.get('DATABASE_HOST', None),\n 'PORT': os.environ.get('DATABASE_PORT', None),\n 'ATOMIC_REQUESTS': True\n }\n}\n\nCACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',\n }\n}\n\n# Local time zone for this installation. Choices can be found here:\n# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name\n# although not all choices may be available on all operating systems.\n# On Unix systems, a value of None will cause Django to use the same\n# timezone as the operating system.\n# If running in a Windows environment this must be set to the same as your\n# system time zone.\nUSE_TZ = True\nTIME_ZONE = 'Europe/London'\n\nTEST_RUNNER = 'django.test.runner.DiscoverRunner'\n\n# Language code for this installation. All choices can be found here:\n# http://www.i18nguy.com/unicode/language-identifiers.html\nLANGUAGE_CODE = 'en-gb'\n\n# Includes all languages that have >50% coverage in Transifex\n# Taken from Django's default setting for LANGUAGES\ngettext_noop = lambda s: s\nLANGUAGES = (\n ('ar', gettext_noop('Arabic')),\n ('ca', gettext_noop('Catalan')),\n ('cs', gettext_noop('Czech')),\n ('da', gettext_noop('Danish')),\n ('de', gettext_noop('German')),\n ('en-gb', gettext_noop('British English')),\n ('el', gettext_noop('Greek')),\n ('es', gettext_noop('Spanish')),\n ('fi', gettext_noop('Finnish')),\n ('fr', gettext_noop('French')),\n ('it', gettext_noop('Italian')),\n ('ko', gettext_noop('Korean')),\n ('nl', gettext_noop('Dutch')),\n ('pl', gettext_noop('Polish')),\n ('pt', gettext_noop('Portuguese')),\n ('pt-br', gettext_noop('Brazilian Portuguese')),\n ('ro', gettext_noop('Romanian')),\n ('ru', gettext_noop('Russian')),\n ('sk', gettext_noop('Slovak')),\n ('uk', gettext_noop('Ukrainian')),\n ('zh-cn', gettext_noop('Simplified Chinese')),\n)\n\nSITE_ID = 1\n\n# If you set this to False, Django will make some optimizations so as not\n# to load the internationalization machinery.\nUSE_I18N = True\n\n# If you set this to False, Django will not format dates, numbers and\n# calendars according to the current locale\nUSE_L10N = True\n\n# Absolute path to the directory that holds media.\n# Example: \"/home/media/media.lawrence.com/\"\nMEDIA_ROOT = location(\"public/media\")\n\n# URL that handles the media served from MEDIA_ROOT. Make sure to use a\n# trailing slash if there is a path component (optional in other cases).\n# Examples: \"http://media.lawrence.com\", \"http://example.com/media/\"\nMEDIA_URL = '/media/'\n\nSTATIC_URL = '/static/'\nSTATIC_ROOT = location('public/static')\nSTATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'\nSTATICFILES_DIRS = (\n location('static/'),\n)\nSTATICFILES_FINDERS = (\n 'django.contrib.staticfiles.finders.FileSystemFinder',\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder',\n)\n\n# Make this unique, and don't share it with anybody.\nSECRET_KEY = '$)a7n&o80u!6y5t-+jrd3)3!%vh&shg$wqpjpxc!ar&p#!)n1a'\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [\n location('_site/templates'),\n oscar.OSCAR_MAIN_TEMPLATE_DIR,\n ],\n 'OPTIONS': {\n 'loaders': [\n 'django.template.loaders.filesystem.Loader',\n 'django.template.loaders.app_directories.Loader',\n 'django.template.loaders.eggs.Loader',\n ],\n 'context_processors': [\n 'django.contrib.auth.context_processors.auth',\n 'django.core.context_processors.request',\n 'django.core.context_processors.debug',\n 'django.core.context_processors.i18n',\n 'django.core.context_processors.media',\n 'django.core.context_processors.static',\n 'django.contrib.messages.context_processors.messages',\n\n # Oscar specific\n 'oscar.apps.search.context_processors.search_form',\n 'oscar.apps.customer.notifications.context_processors.notifications',\n 'oscar.apps.promotions.context_processors.promotions',\n 'oscar.apps.checkout.context_processors.checkout',\n 'oscar.core.context_processors.metadata',\n ],\n 'debug': DEBUG,\n }\n }\n]\n\nMIDDLEWARE_CLASSES = (\n 'debug_toolbar.middleware.DebugToolbarMiddleware',\n\n 'django.middleware.security.SecurityMiddleware',\n 'whitenoise.middleware.WhiteNoiseMiddleware',\n\n 'django.contrib.sessions.middleware.SessionMiddleware',\n 'django.middleware.csrf.CsrfViewMiddleware',\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\n 'django.contrib.messages.middleware.MessageMiddleware',\n 'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',\n\n # Allow languages to be selected\n 'django.middleware.locale.LocaleMiddleware',\n 'django.middleware.common.CommonMiddleware',\n\n # Ensure a valid basket is added to the request instance for every request\n 'oscar.apps.basket.middleware.BasketMiddleware',\n # Enable the ProfileMiddleware, then add ?cprofile to any\n # URL path to print out profile details\n #'oscar.profiling.middleware.ProfileMiddleware',\n)\n\nROOT_URLCONF = 'urls'\n\n\n# A sample logging configuration. The only tangible logging\n# performed by this configuration is to send an email to\n# the site admins on every HTTP 500 error.\n# See http://docs.djangoproject.com/en/dev/topics/logging for\n# more details on how to customize your logging configuration.\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': True,\n 'formatters': {\n 'verbose': {\n 'format': '%(levelname)s %(asctime)s %(module)s %(message)s',\n },\n 'simple': {\n 'format': '[%(asctime)s] %(message)s'\n },\n },\n 'root': {\n 'level': 'DEBUG',\n 'handlers': ['console'],\n },\n 'handlers': {\n 'null': {\n 'level': 'DEBUG',\n 'class': 'logging.NullHandler',\n },\n 'console': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'formatter': 'simple'\n },\n },\n 'loggers': {\n 'oscar': {\n 'level': 'DEBUG',\n 'propagate': True,\n },\n 'oscar.catalogue.import': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': False,\n },\n 'oscar.alerts': {\n 'handlers': ['null'],\n 'level': 'INFO',\n 'propagate': False,\n },\n\n # Django loggers\n 'django': {\n 'handlers': ['null'],\n 'propagate': True,\n 'level': 'INFO',\n },\n 'django.request': {\n 'handlers': ['console'],\n 'level': 'ERROR',\n 'propagate': True,\n },\n 'django.db.backends': {\n 'level': 'WARNING',\n 'propagate': True,\n },\n # Third party\n 'raven': {\n 'level': 'DEBUG',\n 'handlers': ['console'],\n 'propagate': False,\n },\n 'sorl.thumbnail': {\n 'handlers': ['console'],\n 'propagate': True,\n 'level': 'INFO',\n },\n }\n}\n\n\nINSTALLED_APPS = [\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.sites',\n 'django.contrib.messages',\n 'django.contrib.admin',\n 'django.contrib.flatpages',\n 'django.contrib.staticfiles',\n 'django.contrib.sitemaps',\n 'django_extensions',\n\n # Debug toolbar + extensions\n 'debug_toolbar',\n 'apps.gateway', # For allowing dashboard access\n 'widget_tweaks',\n] + oscar.get_core_apps()\n\n# Add Oscar's custom auth backend so users can sign in using their email\n# address.\nAUTHENTICATION_BACKENDS = (\n 'oscar.apps.customer.auth_backends.EmailBackend',\n 'django.contrib.auth.backends.ModelBackend',\n)\n\nLOGIN_REDIRECT_URL = '/'\nAPPEND_SLASH = True\n\n# ====================\n# Messages contrib app\n# ====================\n\nfrom django.contrib.messages import constants as messages\nMESSAGE_TAGS = {\n messages.ERROR: 'danger'\n}\n\n# Haystack settings\nHAYSTACK_CONNECTIONS = {\n 'default': {\n 'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',\n 'PATH': location('whoosh_index'),\n },\n}\n# Here's a sample Haystack config if using Solr (which is recommended)\n#HAYSTACK_CONNECTIONS = {\n# 'default': {\n# 'ENGINE': 'haystack.backends.solr_backend.SolrEngine',\n# 'URL': u'http://127.0.0.1:8983/solr/oscar_latest/',\n# 'INCLUDE_SPELLING': True\n# },\n#}\n\n# =============\n# Debug Toolbar\n# =============\n\n# Implicit setup can often lead to problems with circular imports, so we\n# explicitly wire up the toolbar\nDEBUG_TOOLBAR_PATCH_SETTINGS = False\nDEBUG_TOOLBAR_PANELS = [\n 'debug_toolbar.panels.versions.VersionsPanel',\n 'debug_toolbar.panels.timer.TimerPanel',\n 'debug_toolbar.panels.settings.SettingsPanel',\n 'debug_toolbar.panels.headers.HeadersPanel',\n 'debug_toolbar.panels.request.RequestPanel',\n 'debug_toolbar.panels.sql.SQLPanel',\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\n 'debug_toolbar.panels.templates.TemplatesPanel',\n 'debug_toolbar.panels.cache.CachePanel',\n 'debug_toolbar.panels.signals.SignalsPanel',\n 'debug_toolbar.panels.logging.LoggingPanel',\n 'debug_toolbar.panels.redirects.RedirectsPanel',\n]\nINTERNAL_IPS = ['127.0.0.1', '::1']\n\n# ==============\n# Oscar settings\n# ==============\n\nfrom oscar.defaults import \n\n# Meta\n# ====\n\nOSCAR_SHOP_TAGLINE = 'Sandbox'\n\nOSCAR_RECENTLY_VIEWED_PRODUCTS = 20\nOSCAR_ALLOW_ANON_CHECKOUT = True\n\n# This is added to each template context by the core context processor. It is\n# useful for test/stage/qa sites where you want to show the version of the site\n# in the page title.\nDISPLAY_VERSION = False\n\n\n# Order processing\n# ================\n\n# Sample order/line status settings. This is quite simplistic. It's like you'll\n# want to override the set_status method on the order object to do more\n# sophisticated things.\nOSCAR_INITIAL_ORDER_STATUS = 'Pending'\nOSCAR_INITIAL_LINE_STATUS = 'Pending'\n\n# This dict defines the new order statuses than an order can move to\nOSCAR_ORDER_STATUS_PIPELINE = {\n 'Pending': ('Being processed', 'Cancelled',),\n 'Being processed': ('Complete', 'Cancelled',),\n 'Cancelled': (),\n 'Complete': (),\n}\n\n# This dict defines the line statuses that will be set when an order's status\n# is changed\nOSCAR_ORDER_STATUS_CASCADE = {\n 'Being processed': 'Being processed',\n 'Cancelled': 'Cancelled',\n 'Complete': 'Shipped',\n}\n\n# LESS/CSS\n# ========\n\n# We default to using CSS files, rather than the LESS files that generate them.\n# If you want to develop Oscar's CSS, then set USE_LESS=True to enable the\n# on-the-fly less processor.\nUSE_LESS = False\n\n\n# Sentry\n# ======\n\nif os.environ.get('SENTRY_DSN'):\n RAVEN_CONFIG = {'dsn': os.environ.get('SENTRY_DSN')}\n LOGGING['handlers']['sentry'] = {\n 'level': 'ERROR',\n 'class': 'raven.contrib.django.raven_compat.handlers.SentryHandler',\n }\n LOGGING['root']['handlers'].append('sentry')\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\n\n\n# Sorl\n# ====\n\nTHUMBNAIL_DEBUG = True\nTHUMBNAIL_KEY_PREFIX = 'oscar-sandbox'\n\n# Django 1.6 has switched to JSON serializing for security reasons, but it does not\n# serialize Models. We should resolve this by extending the\n# django/core/serializers/json.Serializer to have the `dumps` function. Also\n# in tests/config.py\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\n\n# Try and import local settings which can be used to override any of the above.\ntry:\n from settings_local import \nexcept ImportError:\n pass\n", "path": "sites/sandbox/settings.py" } ]	[ { "content": "import os\n\nimport oscar\n\n# Path helper\nlocation = lambda x: os.path.join(\n os.path.dirname(os.path.realpath(__file__)), x)\n\nDEBUG = os.environ.get('DEBUG', 'true') != 'false'\nSQL_DEBUG = DEBUG\n\nALLOWED_HOSTS = [\n 'latest.oscarcommerce.com',\n 'master.oscarcommerce.com'\n]\n\n# This is needed for the hosted version of the sandbox\nADMINS = (\n ('David Winterbottom', '[email protected]'),\n ('Michael van Tellingen', '[email protected]'),\n)\nEMAIL_SUBJECT_PREFIX = '[Oscar sandbox] '\nEMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'\n\nMANAGERS = ADMINS\n\n# Use a Sqlite database by default\nDATABASES = {\n 'default': {\n 'ENGINE': os.environ.get('DATABASE_ENGINE', 'django.db.backends.sqlite3'),\n 'NAME': os.environ.get('DATABASE_NAME', location('db.sqlite')),\n 'USER': os.environ.get('DATABASE_USER', None),\n 'PASSWORD': os.environ.get('DATABASE_PASSWORD', None),\n 'HOST': os.environ.get('DATABASE_HOST', None),\n 'PORT': os.environ.get('DATABASE_PORT', None),\n 'ATOMIC_REQUESTS': True\n }\n}\n\nCACHES = {\n 'default': {\n 'BACKEND': 'django.core.cache.backends.locmem.LocMemCache',\n }\n}\n\n# Local time zone for this installation. Choices can be found here:\n# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name\n# although not all choices may be available on all operating systems.\n# On Unix systems, a value of None will cause Django to use the same\n# timezone as the operating system.\n# If running in a Windows environment this must be set to the same as your\n# system time zone.\nUSE_TZ = True\nTIME_ZONE = 'Europe/London'\n\nTEST_RUNNER = 'django.test.runner.DiscoverRunner'\n\n# Language code for this installation. All choices can be found here:\n# http://www.i18nguy.com/unicode/language-identifiers.html\nLANGUAGE_CODE = 'en-gb'\n\n# Includes all languages that have >50% coverage in Transifex\n# Taken from Django's default setting for LANGUAGES\ngettext_noop = lambda s: s\nLANGUAGES = (\n ('ar', gettext_noop('Arabic')),\n ('ca', gettext_noop('Catalan')),\n ('cs', gettext_noop('Czech')),\n ('da', gettext_noop('Danish')),\n ('de', gettext_noop('German')),\n ('en-gb', gettext_noop('British English')),\n ('el', gettext_noop('Greek')),\n ('es', gettext_noop('Spanish')),\n ('fi', gettext_noop('Finnish')),\n ('fr', gettext_noop('French')),\n ('it', gettext_noop('Italian')),\n ('ko', gettext_noop('Korean')),\n ('nl', gettext_noop('Dutch')),\n ('pl', gettext_noop('Polish')),\n ('pt', gettext_noop('Portuguese')),\n ('pt-br', gettext_noop('Brazilian Portuguese')),\n ('ro', gettext_noop('Romanian')),\n ('ru', gettext_noop('Russian')),\n ('sk', gettext_noop('Slovak')),\n ('uk', gettext_noop('Ukrainian')),\n ('zh-cn', gettext_noop('Simplified Chinese')),\n)\n\nSITE_ID = 1\n\n# If you set this to False, Django will make some optimizations so as not\n# to load the internationalization machinery.\nUSE_I18N = True\n\n# If you set this to False, Django will not format dates, numbers and\n# calendars according to the current locale\nUSE_L10N = True\n\n# Absolute path to the directory that holds media.\n# Example: \"/home/media/media.lawrence.com/\"\nMEDIA_ROOT = location(\"public/media\")\n\n# URL that handles the media served from MEDIA_ROOT. Make sure to use a\n# trailing slash if there is a path component (optional in other cases).\n# Examples: \"http://media.lawrence.com\", \"http://example.com/media/\"\nMEDIA_URL = '/media/'\n\nSTATIC_URL = '/static/'\nSTATIC_ROOT = location('public/static')\nSTATICFILES_STORAGE = 'whitenoise.storage.CompressedManifestStaticFilesStorage'\nSTATICFILES_DIRS = (\n location('static/'),\n)\nSTATICFILES_FINDERS = (\n 'django.contrib.staticfiles.finders.FileSystemFinder',\n 'django.contrib.staticfiles.finders.AppDirectoriesFinder',\n)\n\n# Make this unique, and don't share it with anybody.\nSECRET_KEY = '$)a7n&o80u!6y5t-+jrd3)3!%vh&shg$wqpjpxc!ar&p#!)n1a'\n\nTEMPLATES = [\n {\n 'BACKEND': 'django.template.backends.django.DjangoTemplates',\n 'DIRS': [\n location('templates'),\n oscar.OSCAR_MAIN_TEMPLATE_DIR,\n ],\n 'OPTIONS': {\n 'loaders': [\n 'django.template.loaders.filesystem.Loader',\n 'django.template.loaders.app_directories.Loader',\n 'django.template.loaders.eggs.Loader',\n ],\n 'context_processors': [\n 'django.contrib.auth.context_processors.auth',\n 'django.core.context_processors.request',\n 'django.core.context_processors.debug',\n 'django.core.context_processors.i18n',\n 'django.core.context_processors.media',\n 'django.core.context_processors.static',\n 'django.contrib.messages.context_processors.messages',\n\n # Oscar specific\n 'oscar.apps.search.context_processors.search_form',\n 'oscar.apps.customer.notifications.context_processors.notifications',\n 'oscar.apps.promotions.context_processors.promotions',\n 'oscar.apps.checkout.context_processors.checkout',\n 'oscar.core.context_processors.metadata',\n ],\n 'debug': DEBUG,\n }\n }\n]\n\nMIDDLEWARE_CLASSES = (\n 'debug_toolbar.middleware.DebugToolbarMiddleware',\n\n 'django.middleware.security.SecurityMiddleware',\n 'whitenoise.middleware.WhiteNoiseMiddleware',\n\n 'django.contrib.sessions.middleware.SessionMiddleware',\n 'django.middleware.csrf.CsrfViewMiddleware',\n 'django.contrib.auth.middleware.AuthenticationMiddleware',\n 'django.contrib.messages.middleware.MessageMiddleware',\n 'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',\n\n # Allow languages to be selected\n 'django.middleware.locale.LocaleMiddleware',\n 'django.middleware.common.CommonMiddleware',\n\n # Ensure a valid basket is added to the request instance for every request\n 'oscar.apps.basket.middleware.BasketMiddleware',\n # Enable the ProfileMiddleware, then add ?cprofile to any\n # URL path to print out profile details\n #'oscar.profiling.middleware.ProfileMiddleware',\n)\n\nROOT_URLCONF = 'urls'\n\n\n# A sample logging configuration. The only tangible logging\n# performed by this configuration is to send an email to\n# the site admins on every HTTP 500 error.\n# See http://docs.djangoproject.com/en/dev/topics/logging for\n# more details on how to customize your logging configuration.\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': True,\n 'formatters': {\n 'verbose': {\n 'format': '%(levelname)s %(asctime)s %(module)s %(message)s',\n },\n 'simple': {\n 'format': '[%(asctime)s] %(message)s'\n },\n },\n 'root': {\n 'level': 'DEBUG',\n 'handlers': ['console'],\n },\n 'handlers': {\n 'null': {\n 'level': 'DEBUG',\n 'class': 'logging.NullHandler',\n },\n 'console': {\n 'level': 'DEBUG',\n 'class': 'logging.StreamHandler',\n 'formatter': 'simple'\n },\n },\n 'loggers': {\n 'oscar': {\n 'level': 'DEBUG',\n 'propagate': True,\n },\n 'oscar.catalogue.import': {\n 'handlers': ['console'],\n 'level': 'INFO',\n 'propagate': False,\n },\n 'oscar.alerts': {\n 'handlers': ['null'],\n 'level': 'INFO',\n 'propagate': False,\n },\n\n # Django loggers\n 'django': {\n 'handlers': ['null'],\n 'propagate': True,\n 'level': 'INFO',\n },\n 'django.request': {\n 'handlers': ['console'],\n 'level': 'ERROR',\n 'propagate': True,\n },\n 'django.db.backends': {\n 'level': 'WARNING',\n 'propagate': True,\n },\n # Third party\n 'raven': {\n 'level': 'DEBUG',\n 'handlers': ['console'],\n 'propagate': False,\n },\n 'sorl.thumbnail': {\n 'handlers': ['console'],\n 'propagate': True,\n 'level': 'INFO',\n },\n }\n}\n\n\nINSTALLED_APPS = [\n 'django.contrib.auth',\n 'django.contrib.contenttypes',\n 'django.contrib.sessions',\n 'django.contrib.sites',\n 'django.contrib.messages',\n 'django.contrib.admin',\n 'django.contrib.flatpages',\n 'django.contrib.staticfiles',\n 'django.contrib.sitemaps',\n 'django_extensions',\n\n # Debug toolbar + extensions\n 'debug_toolbar',\n 'apps.gateway', # For allowing dashboard access\n 'widget_tweaks',\n] + oscar.get_core_apps()\n\n# Add Oscar's custom auth backend so users can sign in using their email\n# address.\nAUTHENTICATION_BACKENDS = (\n 'oscar.apps.customer.auth_backends.EmailBackend',\n 'django.contrib.auth.backends.ModelBackend',\n)\n\nLOGIN_REDIRECT_URL = '/'\nAPPEND_SLASH = True\n\n# ====================\n# Messages contrib app\n# ====================\n\nfrom django.contrib.messages import constants as messages\nMESSAGE_TAGS = {\n messages.ERROR: 'danger'\n}\n\n# Haystack settings\nHAYSTACK_CONNECTIONS = {\n 'default': {\n 'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',\n 'PATH': location('whoosh_index'),\n },\n}\n# Here's a sample Haystack config if using Solr (which is recommended)\n#HAYSTACK_CONNECTIONS = {\n# 'default': {\n# 'ENGINE': 'haystack.backends.solr_backend.SolrEngine',\n# 'URL': u'http://127.0.0.1:8983/solr/oscar_latest/',\n# 'INCLUDE_SPELLING': True\n# },\n#}\n\n# =============\n# Debug Toolbar\n# =============\n\n# Implicit setup can often lead to problems with circular imports, so we\n# explicitly wire up the toolbar\nDEBUG_TOOLBAR_PATCH_SETTINGS = False\nDEBUG_TOOLBAR_PANELS = [\n 'debug_toolbar.panels.versions.VersionsPanel',\n 'debug_toolbar.panels.timer.TimerPanel',\n 'debug_toolbar.panels.settings.SettingsPanel',\n 'debug_toolbar.panels.headers.HeadersPanel',\n 'debug_toolbar.panels.request.RequestPanel',\n 'debug_toolbar.panels.sql.SQLPanel',\n 'debug_toolbar.panels.staticfiles.StaticFilesPanel',\n 'debug_toolbar.panels.templates.TemplatesPanel',\n 'debug_toolbar.panels.cache.CachePanel',\n 'debug_toolbar.panels.signals.SignalsPanel',\n 'debug_toolbar.panels.logging.LoggingPanel',\n 'debug_toolbar.panels.redirects.RedirectsPanel',\n]\nINTERNAL_IPS = ['127.0.0.1', '::1']\n\n# ==============\n# Oscar settings\n# ==============\n\nfrom oscar.defaults import \n\n# Meta\n# ====\n\nOSCAR_SHOP_TAGLINE = 'Sandbox'\n\nOSCAR_RECENTLY_VIEWED_PRODUCTS = 20\nOSCAR_ALLOW_ANON_CHECKOUT = True\n\n# This is added to each template context by the core context processor. It is\n# useful for test/stage/qa sites where you want to show the version of the site\n# in the page title.\nDISPLAY_VERSION = False\n\n\n# Order processing\n# ================\n\n# Sample order/line status settings. This is quite simplistic. It's like you'll\n# want to override the set_status method on the order object to do more\n# sophisticated things.\nOSCAR_INITIAL_ORDER_STATUS = 'Pending'\nOSCAR_INITIAL_LINE_STATUS = 'Pending'\n\n# This dict defines the new order statuses than an order can move to\nOSCAR_ORDER_STATUS_PIPELINE = {\n 'Pending': ('Being processed', 'Cancelled',),\n 'Being processed': ('Complete', 'Cancelled',),\n 'Cancelled': (),\n 'Complete': (),\n}\n\n# This dict defines the line statuses that will be set when an order's status\n# is changed\nOSCAR_ORDER_STATUS_CASCADE = {\n 'Being processed': 'Being processed',\n 'Cancelled': 'Cancelled',\n 'Complete': 'Shipped',\n}\n\n# LESS/CSS\n# ========\n\n# We default to using CSS files, rather than the LESS files that generate them.\n# If you want to develop Oscar's CSS, then set USE_LESS=True to enable the\n# on-the-fly less processor.\nUSE_LESS = False\n\n\n# Sentry\n# ======\n\nif os.environ.get('SENTRY_DSN'):\n RAVEN_CONFIG = {'dsn': os.environ.get('SENTRY_DSN')}\n LOGGING['handlers']['sentry'] = {\n 'level': 'ERROR',\n 'class': 'raven.contrib.django.raven_compat.handlers.SentryHandler',\n }\n LOGGING['root']['handlers'].append('sentry')\n INSTALLED_APPS.append('raven.contrib.django.raven_compat')\n\n\n# Sorl\n# ====\n\nTHUMBNAIL_DEBUG = True\nTHUMBNAIL_KEY_PREFIX = 'oscar-sandbox'\n\n# Django 1.6 has switched to JSON serializing for security reasons, but it does not\n# serialize Models. We should resolve this by extending the\n# django/core/serializers/json.Serializer to have the `dumps` function. Also\n# in tests/config.py\nSESSION_SERIALIZER = 'django.contrib.sessions.serializers.JSONSerializer'\n\n# Try and import local settings which can be used to override any of the above.\ntry:\n from settings_local import \nexcept ImportError:\n pass\n", "path": "sites/sandbox/settings.py" } ]	diff --git a/sites/sandbox/settings.py b/sites/sandbox/settings.py index 0f395d12a56..fa2fcf1e11b 100644 --- a/sites/sandbox/settings.py +++ b/sites/sandbox/settings.py @@ -123,7 +123,7 @@ { 'BACKEND': 'django.template.backends.django.DjangoTemplates', 'DIRS': [ - location('_site/templates'), + location('templates'), oscar.OSCAR_MAIN_TEMPLATE_DIR, ], 'OPTIONS': {
freedomofpress__securedrop-359	securedrop_init script in Tails doesn't work right if you run it twice It appends torrc-additions to torrc multiple times, and it should just append it once. securedrop_init script in Tails doesn't work right if you run it twice It appends torrc-additions to torrc multiple times, and it should just append it once.	[ { "content": "#!/usr/bin/env python\n\nimport os, sys, subprocess\n\nif __name__ == '__main__':\n # check for root\n if not os.geteuid()==0:\n sys.exit('You need to run this as root')\n\n # paths\n path_torrc_additions = '/home/amnesia/Persistent/.securedrop/torrc_additions'\n path_torrc_backup = '/etc/tor/torrc.bak'\n path_torrc = '/etc/tor/torrc'\n\n # load torrc_additions\n if os.path.isfile(path_torrc_additions):\n torrc_additions = open(path_torrc_additions).read()\n else:\n sys.exit('Error opening {0} for reading'.format(path_torrc_additions));\n\n # load torrc\n if os.path.isfile(path_torrc_backup):\n torrc = open(path_torrc_backup).read()\n else:\n if os.path.isfile(path_torrc):\n torrc = open(path_torrc).read()\n else:\n sys.exit('Error opening {0} for reading'.format(path_torrc));\n\n # save a backup\n open(path_torrc_backup, 'w').write(torrc)\n\n # append the additions\n open(path_torrc, 'a').write(torrc_additions)\n\n # reload tor\n subprocess.call(['/usr/sbin/service', 'tor', 'reload'])\n\n # success\n subprocess.call(['/usr/bin/sudo', '-u', 'amnesia', '/usr/bin/notify-send', 'Updated torrc', 'You can now connect to your SecureDrop document interface']);\n\n", "path": "tails_files/securedrop_init.py" } ]	[ { "content": "#!/usr/bin/env python\n\nimport os, sys, subprocess\n\nif __name__ == '__main__':\n # check for root\n if not os.geteuid()==0:\n sys.exit('You need to run this as root')\n\n # paths\n path_torrc_additions = '/home/amnesia/Persistent/.securedrop/torrc_additions'\n path_torrc_backup = '/etc/tor/torrc.bak'\n path_torrc = '/etc/tor/torrc'\n\n # load torrc_additions\n if os.path.isfile(path_torrc_additions):\n torrc_additions = open(path_torrc_additions).read()\n else:\n sys.exit('Error opening {0} for reading'.format(path_torrc_additions));\n\n # load torrc\n if os.path.isfile(path_torrc_backup):\n torrc = open(path_torrc_backup).read()\n else:\n if os.path.isfile(path_torrc):\n torrc = open(path_torrc).read()\n else:\n sys.exit('Error opening {0} for reading'.format(path_torrc));\n\n # save a backup\n open(path_torrc_backup, 'w').write(torrc)\n\n # append the additions\n open(path_torrc, 'w').write(torrc+torrc_additions)\n\n # reload tor\n subprocess.call(['/usr/sbin/service', 'tor', 'reload'])\n\n # success\n subprocess.call(['/usr/bin/sudo', '-u', 'amnesia', '/usr/bin/notify-send', 'Updated torrc', 'You can now connect to your SecureDrop document interface']);\n\n", "path": "tails_files/securedrop_init.py" } ]	diff --git a/tails_files/securedrop_init.py b/tails_files/securedrop_init.py index 1c43513917..c9b9e2d7bd 100644 --- a/tails_files/securedrop_init.py +++ b/tails_files/securedrop_init.py @@ -31,7 +31,7 @@ open(path_torrc_backup, 'w').write(torrc) # append the additions - open(path_torrc, 'a').write(torrc_additions) + open(path_torrc, 'w').write(torrc+torrc_additions) # reload tor subprocess.call(['/usr/sbin/service', 'tor', 'reload'])
liqd__a4-meinberlin-951	Projectcontainer active projects count broken https://mein.berlin.de/projects/stadtforum-berlin-wohnen/ shows `7 of 4` active projects.	[ { "content": "from django.db import models\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.projects import models as project_models\n\n\nclass ProjectContainer(project_models.Project):\n projects = models.ManyToManyField(\n project_models.Project,\n related_name='containers',\n verbose_name=_('Projects')\n )\n\n @property\n def not_archived_projects(self):\n return self.projects.filter(is_archived=False)\n\n @property\n def active_projects(self):\n now = timezone.now()\n return self.projects.filter(\n module__phase__start_date__lte=now,\n module__phase__end_date__gt=now)\n\n @property\n def phases(self):\n from adhocracy4.phases import models as phase_models\n return phase_models.Phase.objects\\\n .filter(module__project__containers__id=self.id)\n", "path": "meinberlin/apps/projectcontainers/models.py" } ]	[ { "content": "from django.db import models\nfrom django.utils import timezone\nfrom django.utils.translation import ugettext_lazy as _\n\nfrom adhocracy4.projects import models as project_models\n\n\nclass ProjectContainer(project_models.Project):\n projects = models.ManyToManyField(\n project_models.Project,\n related_name='containers',\n verbose_name=_('Projects')\n )\n\n @property\n def not_archived_projects(self):\n return self.projects.filter(is_archived=False)\n\n @property\n def active_projects(self):\n now = timezone.now()\n return self.projects.filter(\n module__phase__start_date__lte=now,\n module__phase__end_date__gt=now).distinct()\n\n @property\n def phases(self):\n from adhocracy4.phases import models as phase_models\n return phase_models.Phase.objects\\\n .filter(module__project__containers__id=self.id)\n", "path": "meinberlin/apps/projectcontainers/models.py" } ]	diff --git a/meinberlin/apps/projectcontainers/models.py b/meinberlin/apps/projectcontainers/models.py index dc3a40aac3..4919b720f0 100644 --- a/meinberlin/apps/projectcontainers/models.py +++ b/meinberlin/apps/projectcontainers/models.py @@ -21,7 +21,7 @@ def active_projects(self): now = timezone.now() return self.projects.filter( module__phase__start_date__lte=now, - module__phase__end_date__gt=now) + module__phase__end_date__gt=now).distinct() @property def phases(self):
svthalia__concrexit-3136	Liked photos API returns duplicate photos on different api requests ### Describe the bug Different pages of the liked photos API return the same photo ### How to reproduce Difficult, this is using @JeeVee11's account as I could not reproduce it. https://staging.thalia.nu/api/v2/photos/photos/liked/?limit=10&offset=0 https://staging.thalia.nu/api/v2/photos/photos/liked/?limit=30&offset=10 Both have pk=70 ### Expected behaviour this should kinda not happen ### Additional context This is likely related to photos not following order and https://github.com/svthalia/Reaxit/issues/359	[ { "content": "from django.db.models import Count, Prefetch, Q\n\nfrom oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope\nfrom rest_framework import filters, status\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.generics import ListAPIView, RetrieveAPIView\nfrom rest_framework.response import Response\nfrom rest_framework.views import APIView\n\nfrom photos import services\nfrom photos.api.v2.serializers.album import (\n AlbumListSerializer,\n AlbumSerializer,\n PhotoListSerializer,\n)\nfrom photos.models import Album, Like, Photo\nfrom utils.media.services import fetch_thumbnails_db\n\n\nclass AlbumListView(ListAPIView):\n \"\"\"Returns an overview of all albums.\"\"\"\n\n serializer_class = AlbumListSerializer\n\n def get_serializer(self, args, kwargs):\n if len(args) > 0:\n albums = args[0]\n fetch_thumbnails_db([album.cover.file for album in albums if album.cover])\n return super().get_serializer(args, *kwargs)\n\n queryset = Album.objects.filter(hidden=False).select_related(\"_cover\")\n\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n filter_backends = (filters.SearchFilter,)\n search_fields = (\"title\", \"date\", \"slug\")\n\n\nclass AlbumDetailView(RetrieveAPIView):\n \"\"\"Returns the details of an album.\"\"\"\n\n serializer_class = AlbumSerializer\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n lookup_field = \"slug\"\n\n def retrieve(self, request, args, *kwargs):\n if not services.is_album_accessible(request, self.get_object()):\n raise PermissionDenied\n return super().retrieve(request, args, *kwargs)\n\n def get_object(self):\n object = super().get_object()\n fetch_thumbnails_db([photo.file for photo in object.photo_set.all()])\n return object\n\n def get_queryset(self):\n photos = Photo.objects.select_properties(\"num_likes\")\n if self.request.member:\n photos = photos.annotate(\n member_likes=Count(\"likes\", filter=Q(likes__member=self.request.member))\n )\n\n # Fix select_properties dropping the default ordering.\n photos = photos.order_by(\"pk\")\n\n return Album.objects.filter(hidden=False).prefetch_related(\n Prefetch(\"photo_set\", queryset=photos)\n )\n\n\nclass LikedPhotosListView(ListAPIView):\n \"\"\"Returns the details the liked album.\"\"\"\n\n serializer_class = PhotoListSerializer\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n\n def get(self, request, args, *kwargs):\n if not self.request.member:\n return Response(\n data={\n \"detail\": \"You need to be a member in order to view your liked photos.\"\n },\n status=status.HTTP_403_FORBIDDEN,\n )\n return self.list(request, args, *kwargs)\n\n def get_serializer(self, args, *kwargs):\n if len(args) > 0:\n photos = args[0]\n fetch_thumbnails_db([photo.file for photo in photos])\n return super().get_serializer(args, kwargs)\n\n def get_queryset(self):\n return (\n Photo.objects.filter(likes__member=self.request.member, album__hidden=False)\n .annotate(\n member_likes=Count(\"likes\", filter=Q(likes__member=self.request.member))\n )\n .select_properties(\"num_likes\")\n )\n\n\nclass PhotoLikeView(APIView):\n permission_classes = [IsAuthenticatedOrTokenHasScope]\n required_scopes = [\"photos:read\"]\n\n def get(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_200_OK,\n )\n\n def post(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n _, created = Like.objects.get_or_create(photo=photo, member=request.member)\n\n if created:\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_201_CREATED,\n )\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_200_OK,\n )\n\n def delete(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n try:\n like = Like.objects.filter(photo__album__hidden=False).get(\n member=request.member, photo__pk=photo_id\n )\n except Like.DoesNotExist:\n return Response(\n {\n \"liked\": False,\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_204_NO_CONTENT,\n )\n\n like.delete()\n\n return Response(\n {\n \"liked\": False,\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_202_ACCEPTED,\n )\n", "path": "website/photos/api/v2/views.py" } ]	[ { "content": "from django.db.models import Count, Prefetch, Q\n\nfrom oauth2_provider.contrib.rest_framework import IsAuthenticatedOrTokenHasScope\nfrom rest_framework import filters, status\nfrom rest_framework.exceptions import PermissionDenied\nfrom rest_framework.generics import ListAPIView, RetrieveAPIView\nfrom rest_framework.response import Response\nfrom rest_framework.views import APIView\n\nfrom photos import services\nfrom photos.api.v2.serializers.album import (\n AlbumListSerializer,\n AlbumSerializer,\n PhotoListSerializer,\n)\nfrom photos.models import Album, Like, Photo\nfrom utils.media.services import fetch_thumbnails_db\n\n\nclass AlbumListView(ListAPIView):\n \"\"\"Returns an overview of all albums.\"\"\"\n\n serializer_class = AlbumListSerializer\n\n def get_serializer(self, args, kwargs):\n if len(args) > 0:\n albums = args[0]\n fetch_thumbnails_db([album.cover.file for album in albums if album.cover])\n return super().get_serializer(args, *kwargs)\n\n queryset = Album.objects.filter(hidden=False).select_related(\"_cover\")\n\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n filter_backends = (filters.SearchFilter,)\n search_fields = (\"title\", \"date\", \"slug\")\n\n\nclass AlbumDetailView(RetrieveAPIView):\n \"\"\"Returns the details of an album.\"\"\"\n\n serializer_class = AlbumSerializer\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n lookup_field = \"slug\"\n\n def retrieve(self, request, args, *kwargs):\n if not services.is_album_accessible(request, self.get_object()):\n raise PermissionDenied\n return super().retrieve(request, args, *kwargs)\n\n def get_object(self):\n object = super().get_object()\n fetch_thumbnails_db([photo.file for photo in object.photo_set.all()])\n return object\n\n def get_queryset(self):\n photos = Photo.objects.select_properties(\"num_likes\")\n if self.request.member:\n photos = photos.annotate(\n member_likes=Count(\"likes\", filter=Q(likes__member=self.request.member))\n )\n\n # Fix select_properties dropping the default ordering.\n photos = photos.order_by(\"pk\")\n\n return Album.objects.filter(hidden=False).prefetch_related(\n Prefetch(\"photo_set\", queryset=photos)\n )\n\n\nclass LikedPhotosListView(ListAPIView):\n \"\"\"Returns the details the liked album.\"\"\"\n\n serializer_class = PhotoListSerializer\n permission_classes = [\n IsAuthenticatedOrTokenHasScope,\n ]\n required_scopes = [\"photos:read\"]\n\n def get(self, request, args, *kwargs):\n if not self.request.member:\n return Response(\n data={\n \"detail\": \"You need to be a member in order to view your liked photos.\"\n },\n status=status.HTTP_403_FORBIDDEN,\n )\n return self.list(request, args, *kwargs)\n\n def get_serializer(self, args, *kwargs):\n if len(args) > 0:\n photos = args[0]\n fetch_thumbnails_db([photo.file for photo in photos])\n return super().get_serializer(args, kwargs)\n\n def get_queryset(self):\n return (\n Photo.objects.filter(likes__member=self.request.member, album__hidden=False)\n .annotate(\n member_likes=Count(\"likes\", filter=Q(likes__member=self.request.member))\n )\n .select_properties(\"num_likes\")\n # Fix select_properties dropping the default ordering.\n .order_by(\"pk\")\n )\n\n\nclass PhotoLikeView(APIView):\n permission_classes = [IsAuthenticatedOrTokenHasScope]\n required_scopes = [\"photos:read\"]\n\n def get(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_200_OK,\n )\n\n def post(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n _, created = Like.objects.get_or_create(photo=photo, member=request.member)\n\n if created:\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_201_CREATED,\n )\n return Response(\n {\n \"liked\": photo.likes.filter(member=request.member).exists(),\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_200_OK,\n )\n\n def delete(self, request, kwargs):\n photo_id = kwargs.get(\"pk\")\n try:\n photo = Photo.objects.filter(album__hidden=False).get(pk=photo_id)\n except Photo.DoesNotExist:\n return Response(status=status.HTTP_404_NOT_FOUND)\n\n try:\n like = Like.objects.filter(photo__album__hidden=False).get(\n member=request.member, photo__pk=photo_id\n )\n except Like.DoesNotExist:\n return Response(\n {\n \"liked\": False,\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_204_NO_CONTENT,\n )\n\n like.delete()\n\n return Response(\n {\n \"liked\": False,\n \"num_likes\": photo.num_likes,\n },\n status=status.HTTP_202_ACCEPTED,\n )\n", "path": "website/photos/api/v2/views.py" } ]	diff --git a/website/photos/api/v2/views.py b/website/photos/api/v2/views.py index ae3589829..10272b20d 100644 --- a/website/photos/api/v2/views.py +++ b/website/photos/api/v2/views.py @@ -105,6 +105,8 @@ def get_queryset(self): member_likes=Count("likes", filter=Q(likes__member=self.request.member)) ) .select_properties("num_likes") + # Fix select_properties dropping the default ordering. + .order_by("pk") )
bentoml__BentoML-1233	Respect Docker env variables when creating docker API client in bentoml containerize Is your feature request related to a problem? Please describe. When building Docker images for a private Docker registry, Docker authentication is required. However, since BentoML uses `docker.APIClient()` instead of `docker.from_env().api` to create the API client, environment variables aren't read (including ones important for authentication). Everything works fine if you perform a docker login first, but that means that my CI build needs to install the docker CLI (or use a custom image with docker already installed), which is a minor annoyance. Describe the solution you'd like Switch out `docker.APIClient()` for `docker.from_env().api` (specifically in the bentoml containerize call) Describe alternatives you've considered `sed 's/docker.APIClient()/docker.from_env().api/g' -i [somepath]/bento_service.py` is the simple monkey patch I'm using at the moment. Alternatively, you can install docker in the CI builder and call login. Happy to write the PR myself if you like, though I figured that opening a new pull request and submitting it may be more work than changing the code in this case.	[ { "content": "import click\nimport sys\nimport os\nimport json\nimport re\nimport psutil\n\nfrom bentoml import __version__\nfrom bentoml.utils.lazy_loader import LazyLoader\nfrom bentoml.utils.s3 import is_s3_url\nfrom bentoml.utils.gcs import is_gcs_url\nfrom bentoml.server.api_server import BentoAPIServer\nfrom bentoml.exceptions import BentoMLException, CLIException\nfrom bentoml.server import start_dev_server, start_prod_server\nfrom bentoml.server.open_api import get_open_api_spec_json\nfrom bentoml.utils import (\n ProtoMessageToDict,\n status_pb_to_error_code_and_message,\n)\nfrom bentoml.cli.click_utils import (\n CLI_COLOR_WARNING,\n CLI_COLOR_SUCCESS,\n _echo,\n BentoMLCommandGroup,\n conditional_argument,\n)\nfrom bentoml.cli.utils import (\n echo_docker_api_result,\n Spinner,\n get_default_yatai_client,\n)\nfrom bentoml.saved_bundle import (\n load,\n load_bento_service_api,\n load_bento_service_metadata,\n)\n\ntry:\n import click_completion\n\n click_completion.init()\n shell_types = click_completion.DocumentedChoice(click_completion.core.shells)\nexcept ImportError:\n # click_completion package is optional to use BentoML cli,\n click_completion = None\n shell_types = click.Choice(['bash', 'zsh', 'fish', 'powershell'])\n\n\nyatai_proto = LazyLoader('yatai_proto', globals(), 'bentoml.yatai.proto')\n\n\ndef escape_shell_params(param):\n k, v = param.split('=')\n v = re.sub(r'([^a-zA-Z0-9])', r'\\\\\\1', v)\n return '{}={}'.format(k, v)\n\n\ndef to_valid_docker_image_name(name):\n # https://docs.docker.com/engine/reference/commandline/tag/#extended-description\n return name.lower().strip(\"._-\")\n\n\ndef to_valid_docker_image_version(version):\n # https://docs.docker.com/engine/reference/commandline/tag/#extended-description\n return version.encode(\"ascii\", errors=\"ignore\").decode().lstrip(\".-\")[:128]\n\n\ndef validate_tag(ctx, param, tag): # pylint: disable=unused-argument\n if tag is None:\n return tag\n\n if \":\" in tag:\n name, version = tag.split(\":\")[:2]\n else:\n name, version = tag, None\n\n valid_name_pattern = re.compile(\n r\"\"\"\n ^(\n [a-z0-9]+ # alphanumeric\n (.\|_{1,2}\|-+)? # seperators\n )*$\n \"\"\",\n re.VERBOSE,\n )\n valid_version_pattern = re.compile(\n r\"\"\"\n ^\n [a-zA-Z0-9] # cant start with .-\n [ -~]{,127} # ascii match rest, cap at 128\n $\n \"\"\",\n re.VERBOSE,\n )\n\n if not valid_name_pattern.match(name):\n raise click.BadParameter(\n f\"Provided Docker Image tag {tag} is invalid. \"\n \"Name components may contain lowercase letters, digits \"\n \"and separators. A separator is defined as a period, \"\n \"one or two underscores, or one or more dashes.\",\n ctx=ctx,\n param=param,\n )\n if version and not valid_version_pattern.match(version):\n raise click.BadParameter(\n f\"Provided Docker Image tag {tag} is invalid. \"\n \"A tag name must be valid ASCII and may contain \"\n \"lowercase and uppercase letters, digits, underscores, \"\n \"periods and dashes. A tag name may not start with a period \"\n \"or a dash and may contain a maximum of 128 characters.\",\n ctx=ctx,\n param=param,\n )\n return tag\n\n\ndef resolve_bundle_path(bento, pip_installed_bundle_path):\n if pip_installed_bundle_path:\n assert (\n bento is None\n ), \"pip installed BentoService commands should not have Bento argument\"\n return pip_installed_bundle_path\n\n if os.path.isdir(bento) or is_s3_url(bento) or is_gcs_url(bento):\n # saved_bundle already support loading local, s3 path and gcs path\n return bento\n\n elif \":\" in bento:\n # assuming passing in BentoService in the form of Name:Version tag\n yatai_client = get_default_yatai_client()\n name, version = bento.split(':')\n get_bento_result = yatai_client.repository.get(name, version)\n if get_bento_result.status.status_code != yatai_proto.status_pb2.Status.OK:\n error_code, error_message = status_pb_to_error_code_and_message(\n get_bento_result.status\n )\n raise BentoMLException(\n f'BentoService {name}:{version} not found - '\n f'{error_code}:{error_message}'\n )\n if get_bento_result.bento.uri.s3_presigned_url:\n # Use s3 presigned URL for downloading the repository if it is presented\n return get_bento_result.bento.uri.s3_presigned_url\n if get_bento_result.bento.uri.gcs_presigned_url:\n return get_bento_result.bento.uri.gcs_presigned_url\n else:\n return get_bento_result.bento.uri.uri\n else:\n raise BentoMLException(\n f'BentoService \"{bento}\" not found - either specify the file path of '\n f'the BentoService saved bundle, or the BentoService id in the form of '\n f'\"name:version\"'\n )\n\n\ndef create_bento_service_cli(pip_installed_bundle_path=None):\n # pylint: disable=unused-variable\n\n @click.group(cls=BentoMLCommandGroup)\n @click.version_option(version=__version__)\n def bentoml_cli():\n \"\"\"\n BentoML CLI tool\n \"\"\"\n\n # Example Usage: bentoml run {API_NAME} {BUNDLE_PATH} --input=...\n @bentoml_cli.command(\n help=\"Run a API defined in saved BentoService bundle from command line\",\n short_help=\"Run API function\",\n context_settings=dict(ignore_unknown_options=True, allow_extra_args=True),\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.argument(\"api_name\", type=click.STRING)\n @click.argument('run_args', nargs=-1, type=click.UNPROCESSED)\n def run(api_name, run_args, bento=None):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n api = load_bento_service_api(saved_bundle_path, api_name)\n exit_code = api.handle_cli(run_args)\n sys.exit(exit_code)\n\n # Example Usage: bentoml info {BUNDLE_PATH}\n @bentoml_cli.command(\n help=\"List all APIs defined in the BentoService loaded from saved bundle\",\n short_help=\"List APIs\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n def info(bento=None):\n \"\"\"\n List all APIs defined in the BentoService loaded from saved bundle\n \"\"\"\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n bento_service_metadata_pb = load_bento_service_metadata(saved_bundle_path)\n output = json.dumps(ProtoMessageToDict(bento_service_metadata_pb), indent=2)\n _echo(output)\n\n # Example usage: bentoml open-api-spec {BUNDLE_PATH}\n @bentoml_cli.command(\n name=\"open-api-spec\",\n help=\"Display API specification JSON in Open-API format\",\n short_help=\"Display OpenAPI/Swagger JSON specs\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n def open_api_spec(bento=None):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n bento_service = load(saved_bundle_path)\n\n _echo(json.dumps(get_open_api_spec_json(bento_service), indent=2))\n\n # Example Usage: bentoml serve {BUNDLE_PATH} --port={PORT}\n @bentoml_cli.command(\n help=\"Start a dev API server serving specified BentoService\",\n short_help=\"Start local dev API server\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.option(\n \"--port\",\n type=click.INT,\n default=BentoAPIServer.DEFAULT_PORT,\n help=f\"The port to listen on for the REST api server, \"\n f\"default is {BentoAPIServer.DEFAULT_PORT}\",\n envvar='BENTOML_PORT',\n )\n @click.option(\n '--enable-microbatch/--disable-microbatch',\n default=False,\n help=\"Run API server with micro-batch enabled\",\n envvar='BENTOML_ENABLE_MICROBATCH',\n )\n @click.option(\n '--run-with-ngrok',\n is_flag=True,\n default=False,\n help=\"Use ngrok to relay traffic on a public endpoint to this \"\n \"API server on localhost\",\n envvar='BENTOML_ENABLE_NGROK',\n )\n def serve(port, bento=None, enable_microbatch=False, run_with_ngrok=False):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n start_dev_server(saved_bundle_path, port, enable_microbatch, run_with_ngrok)\n\n # Example Usage:\n # bentoml serve-gunicorn {BUNDLE_PATH} --port={PORT} --workers={WORKERS}\n @bentoml_cli.command(\n help=\"Start a production API server serving specified BentoService\",\n short_help=\"Start production API server\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.option(\n \"-p\",\n \"--port\",\n type=click.INT,\n default=BentoAPIServer.DEFAULT_PORT,\n help=f\"The port to listen on for the REST api server, \"\n f\"default is {BentoAPIServer.DEFAULT_PORT}\",\n envvar='BENTOML_PORT',\n )\n @click.option(\n \"-w\",\n \"--workers\",\n type=click.INT,\n default=None,\n help=\"Number of workers will start for the gunicorn server\",\n envvar='BENTOML_GUNICORN_WORKERS',\n )\n @click.option(\"--timeout\", type=click.INT, default=None)\n @click.option(\n '--enable-microbatch/--disable-microbatch',\n default=False,\n help=\"Run API server with micro batch enabled\",\n envvar='BENTOML_ENABLE_MICROBATCH',\n )\n @click.option(\n '--microbatch-workers',\n type=click.INT,\n default=1,\n help=\"Number of micro-batch request dispatcher workers\",\n envvar='BENTOML_MICROBATCH_WORKERS',\n )\n def serve_gunicorn(\n port,\n workers,\n timeout,\n bento=None,\n enable_microbatch=False,\n microbatch_workers=1,\n ):\n if not psutil.POSIX:\n _echo(\n \"The `bentoml serve-gunicorn` command is only supported on POSIX. \"\n \"On windows platform, use `bentoml serve` for local API testing and \"\n \"docker for running production API endpoint: \"\n \"https://docs.docker.com/docker-for-windows/ \"\n )\n return\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n start_prod_server(\n saved_bundle_path,\n port,\n timeout,\n workers,\n enable_microbatch,\n microbatch_workers,\n )\n\n @bentoml_cli.command(\n help=\"Install shell command completion\",\n short_help=\"Install shell command completion\",\n )\n @click.option(\n '--append/--overwrite',\n help=\"Append the completion code to the file\",\n default=None,\n )\n @click.argument('shell', required=False, type=shell_types)\n @click.argument('path', required=False)\n def install_completion(append, shell, path):\n if click_completion:\n # click_completion package is imported\n shell, path = click_completion.core.install(\n shell=shell, path=path, append=append\n )\n click.echo('%s completion installed in %s' % (shell, path))\n else:\n click.echo(\n \"'click_completion' is required for BentoML auto-completion, \"\n \"install it with `pip install click_completion`\"\n )\n\n @bentoml_cli.command(\n help='Containerizes given Bento into a ready-to-use Docker image.',\n short_help=\"Containerizes given Bento into a ready-to-use Docker image\",\n )\n @click.argument(\"bento\", type=click.STRING)\n @click.option('--push', is_flag=True)\n @click.option(\n '-t',\n '--tag',\n help=\"Optional image tag. If not specified, Bento will generate one from \"\n \"the name of the Bento.\",\n required=False,\n callback=validate_tag,\n )\n @click.option(\n '--build-arg', multiple=True, help=\"pass through docker image build arguments\"\n )\n @click.option(\n '-u', '--username', type=click.STRING, required=False,\n )\n @click.option(\n '-p', '--password', type=click.STRING, required=False,\n )\n def containerize(bento, push, tag, build_arg, username, password):\n \"\"\"Containerize specified BentoService.\n\n BENTO is the target BentoService to be containerized, referenced by its name\n and version in format of name:version. For example: \"iris_classifier:v1.2.0\"\n\n `bentoml containerize` command also supports the use of the `latest` tag\n which will automatically use the last built version of your Bento.\n\n You can provide a tag for the image built by Bento using the\n `--docker-image-tag` flag. Additionally, you can provide a `--push` flag,\n which will push the built image to the Docker repository specified by the\n image tag.\n\n You can also prefixing the tag with a hostname for the repository you wish\n to push to.\n e.g. `bentoml containerize IrisClassifier:latest --push --tag username/iris`\n would build a Docker image called `username/iris:latest` and push that to\n Docker Hub.\n\n By default, the `containerize` command will use the credentials provided by\n Docker. You may provide your own through `--username` and `--password`.\n \"\"\"\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n _echo(f\"Found Bento: {saved_bundle_path}\")\n\n bento_metadata = load_bento_service_metadata(saved_bundle_path)\n name = to_valid_docker_image_name(bento_metadata.name)\n version = to_valid_docker_image_version(bento_metadata.version)\n\n if not tag:\n _echo(\n \"Tag not specified, using tag parsed from \"\n f\"BentoService: '{name}:{version}'\"\n )\n tag = f\"{name}:{version}\"\n if \":\" not in tag:\n _echo(\n \"Image version not specified, using version parsed \"\n f\"from BentoService: '{version}'\",\n CLI_COLOR_WARNING,\n )\n tag = f\"{tag}:{version}\"\n\n docker_build_args = {}\n if build_arg:\n for arg in build_arg:\n key, value = arg.split(\"=\")\n docker_build_args[key] = value\n\n import docker\n\n docker_api = docker.APIClient()\n try:\n with Spinner(f\"Building Docker image {tag} from {bento} \\n\"):\n for line in echo_docker_api_result(\n docker_api.build(\n path=saved_bundle_path,\n tag=tag,\n decode=True,\n buildargs=docker_build_args,\n )\n ):\n _echo(line)\n except docker.errors.APIError as error:\n raise CLIException(f'Could not build Docker image: {error}')\n\n _echo(\n f'Finished building {tag} from {bento}', CLI_COLOR_SUCCESS,\n )\n\n if push:\n auth_config_payload = (\n {\"username\": username, \"password\": password}\n if username or password\n else None\n )\n\n try:\n with Spinner(f\"Pushing docker image to {tag}\\n\"):\n for line in echo_docker_api_result(\n docker_api.push(\n repository=tag,\n stream=True,\n decode=True,\n auth_config=auth_config_payload,\n )\n ):\n _echo(line)\n _echo(\n f'Pushed {tag} to {name}', CLI_COLOR_SUCCESS,\n )\n except (docker.errors.APIError, BentoMLException) as error:\n raise CLIException(f'Could not push Docker image: {error}')\n\n # pylint: enable=unused-variable\n return bentoml_cli\n", "path": "bentoml/cli/bento_service.py" } ]	[ { "content": "import click\nimport sys\nimport os\nimport json\nimport re\nimport psutil\n\nfrom bentoml import __version__\nfrom bentoml.utils.lazy_loader import LazyLoader\nfrom bentoml.utils.s3 import is_s3_url\nfrom bentoml.utils.gcs import is_gcs_url\nfrom bentoml.server.api_server import BentoAPIServer\nfrom bentoml.exceptions import BentoMLException, CLIException\nfrom bentoml.server import start_dev_server, start_prod_server\nfrom bentoml.server.open_api import get_open_api_spec_json\nfrom bentoml.utils import (\n ProtoMessageToDict,\n status_pb_to_error_code_and_message,\n)\nfrom bentoml.cli.click_utils import (\n CLI_COLOR_WARNING,\n CLI_COLOR_SUCCESS,\n _echo,\n BentoMLCommandGroup,\n conditional_argument,\n)\nfrom bentoml.cli.utils import (\n echo_docker_api_result,\n Spinner,\n get_default_yatai_client,\n)\nfrom bentoml.saved_bundle import (\n load,\n load_bento_service_api,\n load_bento_service_metadata,\n)\n\ntry:\n import click_completion\n\n click_completion.init()\n shell_types = click_completion.DocumentedChoice(click_completion.core.shells)\nexcept ImportError:\n # click_completion package is optional to use BentoML cli,\n click_completion = None\n shell_types = click.Choice(['bash', 'zsh', 'fish', 'powershell'])\n\n\nyatai_proto = LazyLoader('yatai_proto', globals(), 'bentoml.yatai.proto')\n\n\ndef escape_shell_params(param):\n k, v = param.split('=')\n v = re.sub(r'([^a-zA-Z0-9])', r'\\\\\\1', v)\n return '{}={}'.format(k, v)\n\n\ndef to_valid_docker_image_name(name):\n # https://docs.docker.com/engine/reference/commandline/tag/#extended-description\n return name.lower().strip(\"._-\")\n\n\ndef to_valid_docker_image_version(version):\n # https://docs.docker.com/engine/reference/commandline/tag/#extended-description\n return version.encode(\"ascii\", errors=\"ignore\").decode().lstrip(\".-\")[:128]\n\n\ndef validate_tag(ctx, param, tag): # pylint: disable=unused-argument\n if tag is None:\n return tag\n\n if \":\" in tag:\n name, version = tag.split(\":\")[:2]\n else:\n name, version = tag, None\n\n valid_name_pattern = re.compile(\n r\"\"\"\n ^(\n [a-z0-9]+ # alphanumeric\n (.\|_{1,2}\|-+)? # seperators\n )*$\n \"\"\",\n re.VERBOSE,\n )\n valid_version_pattern = re.compile(\n r\"\"\"\n ^\n [a-zA-Z0-9] # cant start with .-\n [ -~]{,127} # ascii match rest, cap at 128\n $\n \"\"\",\n re.VERBOSE,\n )\n\n if not valid_name_pattern.match(name):\n raise click.BadParameter(\n f\"Provided Docker Image tag {tag} is invalid. \"\n \"Name components may contain lowercase letters, digits \"\n \"and separators. A separator is defined as a period, \"\n \"one or two underscores, or one or more dashes.\",\n ctx=ctx,\n param=param,\n )\n if version and not valid_version_pattern.match(version):\n raise click.BadParameter(\n f\"Provided Docker Image tag {tag} is invalid. \"\n \"A tag name must be valid ASCII and may contain \"\n \"lowercase and uppercase letters, digits, underscores, \"\n \"periods and dashes. A tag name may not start with a period \"\n \"or a dash and may contain a maximum of 128 characters.\",\n ctx=ctx,\n param=param,\n )\n return tag\n\n\ndef resolve_bundle_path(bento, pip_installed_bundle_path):\n if pip_installed_bundle_path:\n assert (\n bento is None\n ), \"pip installed BentoService commands should not have Bento argument\"\n return pip_installed_bundle_path\n\n if os.path.isdir(bento) or is_s3_url(bento) or is_gcs_url(bento):\n # saved_bundle already support loading local, s3 path and gcs path\n return bento\n\n elif \":\" in bento:\n # assuming passing in BentoService in the form of Name:Version tag\n yatai_client = get_default_yatai_client()\n name, version = bento.split(':')\n get_bento_result = yatai_client.repository.get(name, version)\n if get_bento_result.status.status_code != yatai_proto.status_pb2.Status.OK:\n error_code, error_message = status_pb_to_error_code_and_message(\n get_bento_result.status\n )\n raise BentoMLException(\n f'BentoService {name}:{version} not found - '\n f'{error_code}:{error_message}'\n )\n if get_bento_result.bento.uri.s3_presigned_url:\n # Use s3 presigned URL for downloading the repository if it is presented\n return get_bento_result.bento.uri.s3_presigned_url\n if get_bento_result.bento.uri.gcs_presigned_url:\n return get_bento_result.bento.uri.gcs_presigned_url\n else:\n return get_bento_result.bento.uri.uri\n else:\n raise BentoMLException(\n f'BentoService \"{bento}\" not found - either specify the file path of '\n f'the BentoService saved bundle, or the BentoService id in the form of '\n f'\"name:version\"'\n )\n\n\ndef create_bento_service_cli(pip_installed_bundle_path=None):\n # pylint: disable=unused-variable\n\n @click.group(cls=BentoMLCommandGroup)\n @click.version_option(version=__version__)\n def bentoml_cli():\n \"\"\"\n BentoML CLI tool\n \"\"\"\n\n # Example Usage: bentoml run {API_NAME} {BUNDLE_PATH} --input=...\n @bentoml_cli.command(\n help=\"Run a API defined in saved BentoService bundle from command line\",\n short_help=\"Run API function\",\n context_settings=dict(ignore_unknown_options=True, allow_extra_args=True),\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.argument(\"api_name\", type=click.STRING)\n @click.argument('run_args', nargs=-1, type=click.UNPROCESSED)\n def run(api_name, run_args, bento=None):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n api = load_bento_service_api(saved_bundle_path, api_name)\n exit_code = api.handle_cli(run_args)\n sys.exit(exit_code)\n\n # Example Usage: bentoml info {BUNDLE_PATH}\n @bentoml_cli.command(\n help=\"List all APIs defined in the BentoService loaded from saved bundle\",\n short_help=\"List APIs\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n def info(bento=None):\n \"\"\"\n List all APIs defined in the BentoService loaded from saved bundle\n \"\"\"\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n bento_service_metadata_pb = load_bento_service_metadata(saved_bundle_path)\n output = json.dumps(ProtoMessageToDict(bento_service_metadata_pb), indent=2)\n _echo(output)\n\n # Example usage: bentoml open-api-spec {BUNDLE_PATH}\n @bentoml_cli.command(\n name=\"open-api-spec\",\n help=\"Display API specification JSON in Open-API format\",\n short_help=\"Display OpenAPI/Swagger JSON specs\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n def open_api_spec(bento=None):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n bento_service = load(saved_bundle_path)\n\n _echo(json.dumps(get_open_api_spec_json(bento_service), indent=2))\n\n # Example Usage: bentoml serve {BUNDLE_PATH} --port={PORT}\n @bentoml_cli.command(\n help=\"Start a dev API server serving specified BentoService\",\n short_help=\"Start local dev API server\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.option(\n \"--port\",\n type=click.INT,\n default=BentoAPIServer.DEFAULT_PORT,\n help=f\"The port to listen on for the REST api server, \"\n f\"default is {BentoAPIServer.DEFAULT_PORT}\",\n envvar='BENTOML_PORT',\n )\n @click.option(\n '--enable-microbatch/--disable-microbatch',\n default=False,\n help=\"Run API server with micro-batch enabled\",\n envvar='BENTOML_ENABLE_MICROBATCH',\n )\n @click.option(\n '--run-with-ngrok',\n is_flag=True,\n default=False,\n help=\"Use ngrok to relay traffic on a public endpoint to this \"\n \"API server on localhost\",\n envvar='BENTOML_ENABLE_NGROK',\n )\n def serve(port, bento=None, enable_microbatch=False, run_with_ngrok=False):\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n start_dev_server(saved_bundle_path, port, enable_microbatch, run_with_ngrok)\n\n # Example Usage:\n # bentoml serve-gunicorn {BUNDLE_PATH} --port={PORT} --workers={WORKERS}\n @bentoml_cli.command(\n help=\"Start a production API server serving specified BentoService\",\n short_help=\"Start production API server\",\n )\n @conditional_argument(pip_installed_bundle_path is None, \"bento\", type=click.STRING)\n @click.option(\n \"-p\",\n \"--port\",\n type=click.INT,\n default=BentoAPIServer.DEFAULT_PORT,\n help=f\"The port to listen on for the REST api server, \"\n f\"default is {BentoAPIServer.DEFAULT_PORT}\",\n envvar='BENTOML_PORT',\n )\n @click.option(\n \"-w\",\n \"--workers\",\n type=click.INT,\n default=None,\n help=\"Number of workers will start for the gunicorn server\",\n envvar='BENTOML_GUNICORN_WORKERS',\n )\n @click.option(\"--timeout\", type=click.INT, default=None)\n @click.option(\n '--enable-microbatch/--disable-microbatch',\n default=False,\n help=\"Run API server with micro batch enabled\",\n envvar='BENTOML_ENABLE_MICROBATCH',\n )\n @click.option(\n '--microbatch-workers',\n type=click.INT,\n default=1,\n help=\"Number of micro-batch request dispatcher workers\",\n envvar='BENTOML_MICROBATCH_WORKERS',\n )\n def serve_gunicorn(\n port,\n workers,\n timeout,\n bento=None,\n enable_microbatch=False,\n microbatch_workers=1,\n ):\n if not psutil.POSIX:\n _echo(\n \"The `bentoml serve-gunicorn` command is only supported on POSIX. \"\n \"On windows platform, use `bentoml serve` for local API testing and \"\n \"docker for running production API endpoint: \"\n \"https://docs.docker.com/docker-for-windows/ \"\n )\n return\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n start_prod_server(\n saved_bundle_path,\n port,\n timeout,\n workers,\n enable_microbatch,\n microbatch_workers,\n )\n\n @bentoml_cli.command(\n help=\"Install shell command completion\",\n short_help=\"Install shell command completion\",\n )\n @click.option(\n '--append/--overwrite',\n help=\"Append the completion code to the file\",\n default=None,\n )\n @click.argument('shell', required=False, type=shell_types)\n @click.argument('path', required=False)\n def install_completion(append, shell, path):\n if click_completion:\n # click_completion package is imported\n shell, path = click_completion.core.install(\n shell=shell, path=path, append=append\n )\n click.echo('%s completion installed in %s' % (shell, path))\n else:\n click.echo(\n \"'click_completion' is required for BentoML auto-completion, \"\n \"install it with `pip install click_completion`\"\n )\n\n @bentoml_cli.command(\n help='Containerizes given Bento into a ready-to-use Docker image.',\n short_help=\"Containerizes given Bento into a ready-to-use Docker image\",\n )\n @click.argument(\"bento\", type=click.STRING)\n @click.option('--push', is_flag=True)\n @click.option(\n '-t',\n '--tag',\n help=\"Optional image tag. If not specified, Bento will generate one from \"\n \"the name of the Bento.\",\n required=False,\n callback=validate_tag,\n )\n @click.option(\n '--build-arg', multiple=True, help=\"pass through docker image build arguments\"\n )\n @click.option(\n '-u', '--username', type=click.STRING, required=False,\n )\n @click.option(\n '-p', '--password', type=click.STRING, required=False,\n )\n def containerize(bento, push, tag, build_arg, username, password):\n \"\"\"Containerize specified BentoService.\n\n BENTO is the target BentoService to be containerized, referenced by its name\n and version in format of name:version. For example: \"iris_classifier:v1.2.0\"\n\n `bentoml containerize` command also supports the use of the `latest` tag\n which will automatically use the last built version of your Bento.\n\n You can provide a tag for the image built by Bento using the\n `--docker-image-tag` flag. Additionally, you can provide a `--push` flag,\n which will push the built image to the Docker repository specified by the\n image tag.\n\n You can also prefixing the tag with a hostname for the repository you wish\n to push to.\n e.g. `bentoml containerize IrisClassifier:latest --push --tag username/iris`\n would build a Docker image called `username/iris:latest` and push that to\n Docker Hub.\n\n By default, the `containerize` command will use the credentials provided by\n Docker. You may provide your own through `--username` and `--password`.\n \"\"\"\n saved_bundle_path = resolve_bundle_path(bento, pip_installed_bundle_path)\n\n _echo(f\"Found Bento: {saved_bundle_path}\")\n\n bento_metadata = load_bento_service_metadata(saved_bundle_path)\n name = to_valid_docker_image_name(bento_metadata.name)\n version = to_valid_docker_image_version(bento_metadata.version)\n\n if not tag:\n _echo(\n \"Tag not specified, using tag parsed from \"\n f\"BentoService: '{name}:{version}'\"\n )\n tag = f\"{name}:{version}\"\n if \":\" not in tag:\n _echo(\n \"Image version not specified, using version parsed \"\n f\"from BentoService: '{version}'\",\n CLI_COLOR_WARNING,\n )\n tag = f\"{tag}:{version}\"\n\n docker_build_args = {}\n if build_arg:\n for arg in build_arg:\n key, value = arg.split(\"=\")\n docker_build_args[key] = value\n\n import docker\n\n docker_api = docker.from_env().api\n try:\n with Spinner(f\"Building Docker image {tag} from {bento} \\n\"):\n for line in echo_docker_api_result(\n docker_api.build(\n path=saved_bundle_path,\n tag=tag,\n decode=True,\n buildargs=docker_build_args,\n )\n ):\n _echo(line)\n except docker.errors.APIError as error:\n raise CLIException(f'Could not build Docker image: {error}')\n\n _echo(\n f'Finished building {tag} from {bento}', CLI_COLOR_SUCCESS,\n )\n\n if push:\n auth_config_payload = (\n {\"username\": username, \"password\": password}\n if username or password\n else None\n )\n\n try:\n with Spinner(f\"Pushing docker image to {tag}\\n\"):\n for line in echo_docker_api_result(\n docker_api.push(\n repository=tag,\n stream=True,\n decode=True,\n auth_config=auth_config_payload,\n )\n ):\n _echo(line)\n _echo(\n f'Pushed {tag} to {name}', CLI_COLOR_SUCCESS,\n )\n except (docker.errors.APIError, BentoMLException) as error:\n raise CLIException(f'Could not push Docker image: {error}')\n\n # pylint: enable=unused-variable\n return bentoml_cli\n", "path": "bentoml/cli/bento_service.py" } ]	diff --git a/bentoml/cli/bento_service.py b/bentoml/cli/bento_service.py index 184280a86ea..4cfd078debe 100644 --- a/bentoml/cli/bento_service.py +++ b/bentoml/cli/bento_service.py @@ -406,7 +406,7 @@ def containerize(bento, push, tag, build_arg, username, password): import docker - docker_api = docker.APIClient() + docker_api = docker.from_env().api try: with Spinner(f"Building Docker image {tag} from {bento} \n"): for line in echo_docker_api_result(
DataDog__dd-agent-1047	Windows agent connection error agent version: 4.4 OS: Windows 2008 Standard, SP2. case: https://datadog.desk.com/agent/case/11902 - log snippet: > 2014-06-24 13:45:04 Eastern Daylight Time \| ERROR \| forwarder(ddagent.pyc:240) \| Response: HTTPResponse(_body=None,buffer=None,code=599,effective_url='https://app.datadoghq.com/intake?api_key=#################',error=gaierror(11001, 'getaddrinfo failed'),headers={},reason='Unknown',request=<tornado.httpclient.HTTPRequest object at 0x01212170>,request_time=0.018000125885009766,time_info={}) > > 2014-06-24 13:45:04 Eastern Daylight Time \| WARNING \| transaction(transaction.pyc:213) \| Transaction 4 in error (5 errors), it will be replayed after 2014-06-24 13:46:34 > > 2014-06-24 13:45:05 Eastern Daylight Time \| INFO \| win32.agent(agent.pyc:91) \| pup has died. Restarting... > > 2014-06-24 13:45:05 Eastern Daylight Time \| ERROR \| forwarder(ddagent.pyc:240) \| Response: HTTPResponse(_body=None,buffer=None,code=599,effective_url='https://app.datadoghq.com/api/v1/series/?api_key=################',error=gaierror(11001, 'getaddrinfo failed` - able to TCP connection (80 and 443) to app.datadoghq.com EDIT: > telnet app.datadoghq.com 80 > telnet app.datadoghq.com 443 - from agent python shell: > print socket.getaddrinfo('app.datadoghq.com',443) > Traceback (most recent call last): > File "shell.py", line 13, in shell > File "<string>", line 1, in <module> > gaierror: [Errno 11001] getaddrinfo failed	[ { "content": "import platform\nimport sys\nfrom config import get_version\nfrom jmxfetch import JMX_FETCH_JAR_NAME\n\ntry:\n from setuptools import setup, find_packages\n\n # required to build the cython extensions\n from distutils.extension import Extension #pylint: disable=no-name-in-module\n\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\n# Extra arguments to pass to the setup function\nextra_args = {}\n\n# Prereqs of the build. Won't get installed when deploying the egg.\nsetup_requires = [\n]\n\n# Prereqs of the install. Will install when deploying the egg.\ninstall_requires=[\n]\n\nif sys.platform == 'win32':\n from glob import glob\n import py2exe\n install_requires.extend([\n 'tornado==3.0.1',\n 'pywin32==217',\n 'wmi==1.4.9',\n 'simplejson==2.6.1',\n 'mysql-python==1.2.3',\n 'pymongo==2.3',\n 'pg8000',\n 'python-memcached==1.48',\n 'adodbapi'\n 'elementtree',\n 'pycurl',\n 'pymysql',\n 'psutil',\n 'redis',\n 'requests',\n 'httplib2==0.9',\n ])\n\n # Modules to force-include in the exe\n include_modules = [\n # 3p\n 'win32service',\n 'win32serviceutil',\n 'win32event',\n 'simplejson',\n 'adodbapi',\n 'elementtree.ElementTree',\n 'pycurl',\n 'tornado.curl_httpclient',\n 'pymongo',\n 'pymysql',\n 'psutil',\n 'pg8000',\n 'redis',\n 'requests',\n\n # agent\n 'checks.services_checks',\n 'httplib2',\n\n # pup\n 'pup',\n 'pup.pup',\n 'tornado.websocket',\n 'tornado.web',\n 'tornado.ioloop',\n ]\n\n class Target(object):\n def __init__(self, *kw):\n self.__dict__.update(kw) \n self.version = get_version()\n self.company_name = 'Datadog, Inc.'\n self.copyright = 'Copyright 2013 Datadog, Inc.'\n self.cmdline_style = 'pywin32'\n\n agent_svc = Target(name='Datadog Agent', modules='win32.agent', dest_base='ddagent')\n\n extra_args = {\n 'options': {\n 'py2exe': {\n 'includes': ','.join(include_modules),\n 'optimize': 0,\n 'compressed': True,\n 'bundle_files': 3,\n },\n },\n 'console': ['win32\\shell.py'],\n 'service': [agent_svc],\n 'windows': [{'script': 'win32\\gui.py',\n 'dest_base': \"agent-manager\",\n 'uac_info': \"requireAdministrator\", # The manager needs to be administrator to stop/start the service\n 'icon_resources': [(1, r\"packaging\\datadog-agent\\win32\\install_files\\dd_agent_win_256.ico\")],\n }],\n 'data_files': [\n (\"Microsoft.VC90.CRT\", glob(r'C:\\Python27\\redist\\.')),\n ('pup', glob('pup/pup.html')),\n ('pup', glob('pup/status.html')),\n ('pup/static', glob('pup/static/.')),\n ('jmxfetch', glob('checks/libs/%s' % JMX_FETCH_JAR_NAME)),\n ],\n }\n\nsetup(\n name='datadog-agent',\n version=get_version(),\n description=\"DevOps' best friend\",\n author='DataDog',\n author_email='[email protected]',\n url='http://www.datadoghq.com',\n install_requires=install_requires,\n setup_requires=setup_requires,\n packages=find_packages(exclude=['ez_setup']),\n include_package_data=True,\n test_suite='nose.collector',\n zip_safe=False,\n *extra_args\n)\n", "path": "setup.py" } ]	[ { "content": "import platform\nimport sys\nfrom config import \nfrom jmxfetch import JMX_FETCH_JAR_NAME\n\ntry:\n from setuptools import setup, find_packages\n\n # required to build the cython extensions\n from distutils.extension import Extension #pylint: disable=no-name-in-module\n\nexcept ImportError:\n from ez_setup import use_setuptools\n use_setuptools()\n from setuptools import setup, find_packages\n\n# Extra arguments to pass to the setup function\nextra_args = {}\n\n# Prereqs of the build. Won't get installed when deploying the egg.\nsetup_requires = [\n]\n\n# Prereqs of the install. Will install when deploying the egg.\ninstall_requires=[\n]\n\nif sys.platform == 'win32':\n from glob import glob\n import py2exe\n install_requires.extend([\n 'tornado==3.0.1',\n 'pywin32==217',\n 'wmi==1.4.9',\n 'simplejson==2.6.1',\n 'mysql-python==1.2.3',\n 'pymongo==2.3',\n 'pg8000',\n 'python-memcached==1.48',\n 'adodbapi'\n 'elementtree',\n 'pycurl',\n 'pymysql',\n 'psutil',\n 'redis',\n 'requests',\n 'httplib2==0.9',\n ])\n\n # Modules to force-include in the exe\n include_modules = [\n # 3p\n 'win32service',\n 'win32serviceutil',\n 'win32event',\n 'simplejson',\n 'adodbapi',\n 'elementtree.ElementTree',\n 'pycurl',\n 'tornado.curl_httpclient',\n 'pymongo',\n 'pymysql',\n 'psutil',\n 'pg8000',\n 'redis',\n 'requests',\n\n # agent\n 'checks.services_checks',\n 'httplib2',\n\n # pup\n 'pup',\n 'pup.pup',\n 'tornado.websocket',\n 'tornado.web',\n 'tornado.ioloop',\n ]\n\n class Target(object):\n def __init__(self, kw):\n self.__dict__.update(kw) \n self.version = get_version()\n self.company_name = 'Datadog, Inc.'\n self.copyright = 'Copyright 2013 Datadog, Inc.'\n self.cmdline_style = 'pywin32'\n\n agent_svc = Target(name='Datadog Agent', modules='win32.agent', dest_base='ddagent')\n\n extra_args = {\n 'options': {\n 'py2exe': {\n 'includes': ','.join(include_modules),\n 'optimize': 0,\n 'compressed': True,\n 'bundle_files': 3,\n 'dll_excludes': [ \"IPHLPAPI.DLL\", \"NSI.dll\", \"WINNSI.DLL\", \"WTSAPI32.dll\"],\n },\n },\n 'console': ['win32\\shell.py'],\n 'service': [agent_svc],\n 'windows': [{'script': 'win32\\gui.py',\n 'dest_base': \"agent-manager\",\n 'uac_info': \"requireAdministrator\", # The manager needs to be administrator to stop/start the service\n 'icon_resources': [(1, r\"packaging\\datadog-agent\\win32\\install_files\\dd_agent_win_256.ico\")],\n }],\n 'data_files': [\n (\"Microsoft.VC90.CRT\", glob(r'C:\\Python27\\redist\\.')),\n ('pup', glob('pup/pup.html')),\n ('pup', glob('pup/status.html')),\n ('pup/static', glob('pup/static/.')),\n ('jmxfetch', glob('checks/libs/%s' % JMX_FETCH_JAR_NAME)),\n ],\n }\n\nsetup(\n name='datadog-agent',\n version=get_version(),\n description=\"DevOps' best friend\",\n author='DataDog',\n author_email='[email protected]',\n url='http://www.datadoghq.com',\n install_requires=install_requires,\n setup_requires=setup_requires,\n packages=find_packages(exclude=['ez_setup']),\n include_package_data=True,\n test_suite='nose.collector',\n zip_safe=False,\n *extra_args\n)\n", "path": "setup.py" } ]	diff --git a/packaging/datadog-agent/win32/build.ps1 b/packaging/datadog-agent/win32/build.ps1 index 3c96964d17..b42d44d3a1 100644 --- a/packaging/datadog-agent/win32/build.ps1 +++ b/packaging/datadog-agent/win32/build.ps1 @@ -3,6 +3,7 @@ $version = "$(python -c "from config import get_version; print get_version()").$ # Remove old artifacts rm -r build/* +rm -r dist/* # Build the agent.exe service python setup.py py2exe diff --git a/setup.py b/setup.py index 464ff5cc9f..8626c49365 100644 --- a/setup.py +++ b/setup.py @@ -94,6 +94,7 @@ def __init__(self, **kw): 'optimize': 0, 'compressed': True, 'bundle_files': 3, + 'dll_excludes': [ "IPHLPAPI.DLL", "NSI.dll", "WINNSI.DLL", "WTSAPI32.dll"], }, }, 'console': ['win32\shell.py'],
DDMAL__CantusDB-1116	Admin Area, Change Source page: we should hide "Source Status" field Debra got tripped up trying to publish a source - instead of checking the "Published" checkbox, she selected something in the "Source Status" dropdown. ~~Everything regarding source visibility is handled by our `published` field, so I think "Source Status" is vestigal and no longer needed. We may not even use it anywhere in our templates/views. With this in mind, it may be worth considering removing this field entirely. (Any data related to this field that was in OldCantus when we last synced is saved in sources' `json_info` field, so we wouldn't really need to worry about losing data.)~~ (it was decided that this information may eventually be useful, so we'll not remove the field from the model)	[ { "content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentForm,\n AdminSequenceForm,\n AdminSourceForm,\n)\n\n# these fields should not be editable by all classes\nEXCLUDE = (\n \"created_by\",\n \"last_updated_by\",\n \"json_info\",\n)\n\n\nclass BaseModelAdmin(admin.ModelAdmin):\n exclude = EXCLUDE\n\n # if an object is created in the admin interface, assign the user to the created_by field\n # else if an object is updated in the admin interface, assign the user to the last_updated_by field\n def save_model(self, request, obj, form, change):\n if change:\n obj.last_updated_by = request.user\n else:\n obj.created_by = request.user\n super().save_model(request, obj, form, change)\n\n\nclass CenturyAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminCenturyForm\n\n\nclass ChantAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n list_display = (\n \"incipit\",\n \"get_source_siglum\",\n \"genre\",\n )\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n\n readonly_fields = (\n \"date_created\",\n \"date_updated\",\n )\n\n list_filter = (\n \"genre\",\n \"office\",\n )\n exclude = EXCLUDE + (\n \"col1\",\n \"col2\",\n \"col3\",\n \"next_chant\",\n \"s_sequence\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n \"date\",\n \"volpiano_notes\",\n \"volpiano_intervals\",\n \"title\",\n \"differentiae_database\",\n )\n form = AdminChantForm\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n\n\nclass DifferentiaAdmin(BaseModelAdmin):\n search_fields = (\n \"differentia_id\",\n \"id\",\n )\n\n\nclass FeastAdmin(BaseModelAdmin):\n search_fields = (\n \"name\",\n \"feast_code\",\n )\n list_display = (\n \"name\",\n \"month\",\n \"day\",\n \"feast_code\",\n )\n form = AdminFeastForm\n\n\nclass GenreAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminGenreForm\n\n\nclass NotationAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminNotationForm\n\n\nclass OfficeAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminOfficeForm\n\n\nclass ProvenanceAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminProvenanceForm\n\n\nclass RismSiglumAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminRismSiglumForm\n\n\nclass SegmentAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminSegmentForm\n\n\nclass SequenceAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n exclude = EXCLUDE + (\n \"c_sequence\",\n \"next_chant\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n )\n list_display = (\"incipit\", \"get_source_siglum\", \"genre\")\n list_filter = (\n \"genre\",\n \"office\",\n )\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n form = AdminSequenceForm\n\n\nclass SourceAdmin(BaseModelAdmin):\n # These search fields are also available on the user-source inline relationship in the user admin page\n search_fields = (\n \"siglum\",\n \"title\",\n \"id\",\n )\n readonly_fields = (\n \"number_of_chants\",\n \"number_of_melodies\",\n \"date_created\",\n \"date_updated\",\n )\n # from the Django docs:\n # Adding a ManyToManyField to this list will instead use a nifty unobtrusive JavaScript “filter” interface\n # that allows searching within the options. The unselected and selected options appear in two boxes side by side.\n filter_horizontal = (\n \"century\",\n \"notation\",\n \"current_editors\",\n \"inventoried_by\",\n \"full_text_entered_by\",\n \"melodies_entered_by\",\n \"proofreaders\",\n \"other_editors\",\n )\n\n list_display = (\n \"title\",\n \"siglum\",\n \"id\",\n )\n\n list_filter = (\n \"full_source\",\n \"segment\",\n \"source_status\",\n \"published\",\n \"century\",\n )\n\n ordering = (\"siglum\",)\n\n form = AdminSourceForm\n\n\nadmin.site.register(Century, CenturyAdmin)\nadmin.site.register(Chant, ChantAdmin)\nadmin.site.register(Differentia, DifferentiaAdmin)\nadmin.site.register(Feast, FeastAdmin)\nadmin.site.register(Genre, GenreAdmin)\nadmin.site.register(Notation, NotationAdmin)\nadmin.site.register(Office, OfficeAdmin)\nadmin.site.register(Provenance, ProvenanceAdmin)\nadmin.site.register(RismSiglum, RismSiglumAdmin)\nadmin.site.register(Segment, SegmentAdmin)\nadmin.site.register(Sequence, SequenceAdmin)\nadmin.site.register(Source, SourceAdmin)\n", "path": "django/cantusdb_project/main_app/admin.py" } ]	[ { "content": "from django.contrib import admin\nfrom main_app.models import *\nfrom main_app.forms import (\n AdminCenturyForm,\n AdminChantForm,\n AdminFeastForm,\n AdminGenreForm,\n AdminNotationForm,\n AdminOfficeForm,\n AdminProvenanceForm,\n AdminRismSiglumForm,\n AdminSegmentForm,\n AdminSequenceForm,\n AdminSourceForm,\n)\n\n# these fields should not be editable by all classes\nEXCLUDE = (\n \"created_by\",\n \"last_updated_by\",\n \"json_info\",\n)\n\n\nclass BaseModelAdmin(admin.ModelAdmin):\n exclude = EXCLUDE\n\n # if an object is created in the admin interface, assign the user to the created_by field\n # else if an object is updated in the admin interface, assign the user to the last_updated_by field\n def save_model(self, request, obj, form, change):\n if change:\n obj.last_updated_by = request.user\n else:\n obj.created_by = request.user\n super().save_model(request, obj, form, change)\n\n\nclass CenturyAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminCenturyForm\n\n\nclass ChantAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n list_display = (\n \"incipit\",\n \"get_source_siglum\",\n \"genre\",\n )\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n\n readonly_fields = (\n \"date_created\",\n \"date_updated\",\n )\n\n list_filter = (\n \"genre\",\n \"office\",\n )\n exclude = EXCLUDE + (\n \"col1\",\n \"col2\",\n \"col3\",\n \"next_chant\",\n \"s_sequence\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n \"date\",\n \"volpiano_notes\",\n \"volpiano_intervals\",\n \"title\",\n \"differentiae_database\",\n )\n form = AdminChantForm\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n\n\nclass DifferentiaAdmin(BaseModelAdmin):\n search_fields = (\n \"differentia_id\",\n \"id\",\n )\n\n\nclass FeastAdmin(BaseModelAdmin):\n search_fields = (\n \"name\",\n \"feast_code\",\n )\n list_display = (\n \"name\",\n \"month\",\n \"day\",\n \"feast_code\",\n )\n form = AdminFeastForm\n\n\nclass GenreAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminGenreForm\n\n\nclass NotationAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminNotationForm\n\n\nclass OfficeAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminOfficeForm\n\n\nclass ProvenanceAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminProvenanceForm\n\n\nclass RismSiglumAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminRismSiglumForm\n\n\nclass SegmentAdmin(BaseModelAdmin):\n search_fields = (\"name\",)\n form = AdminSegmentForm\n\n\nclass SequenceAdmin(BaseModelAdmin):\n @admin.display(description=\"Source Siglum\")\n def get_source_siglum(self, obj):\n if obj.source:\n return obj.source.siglum\n\n search_fields = (\n \"title\",\n \"incipit\",\n \"cantus_id\",\n \"id\",\n )\n exclude = EXCLUDE + (\n \"c_sequence\",\n \"next_chant\",\n \"is_last_chant_in_feast\",\n \"visible_status\",\n )\n list_display = (\"incipit\", \"get_source_siglum\", \"genre\")\n list_filter = (\n \"genre\",\n \"office\",\n )\n raw_id_fields = (\n \"source\",\n \"feast\",\n )\n ordering = (\"source__siglum\",)\n form = AdminSequenceForm\n\n\nclass SourceAdmin(BaseModelAdmin):\n exclude = (\"source_status\",)\n\n # These search fields are also available on the user-source inline relationship in the user admin page\n search_fields = (\n \"siglum\",\n \"title\",\n \"id\",\n )\n readonly_fields = (\n \"number_of_chants\",\n \"number_of_melodies\",\n \"date_created\",\n \"date_updated\",\n )\n # from the Django docs:\n # Adding a ManyToManyField to this list will instead use a nifty unobtrusive JavaScript “filter” interface\n # that allows searching within the options. The unselected and selected options appear in two boxes side by side.\n filter_horizontal = (\n \"century\",\n \"notation\",\n \"current_editors\",\n \"inventoried_by\",\n \"full_text_entered_by\",\n \"melodies_entered_by\",\n \"proofreaders\",\n \"other_editors\",\n )\n\n list_display = (\n \"title\",\n \"siglum\",\n \"id\",\n )\n\n list_filter = (\n \"full_source\",\n \"segment\",\n \"source_status\",\n \"published\",\n \"century\",\n )\n\n ordering = (\"siglum\",)\n\n form = AdminSourceForm\n\n\nadmin.site.register(Century, CenturyAdmin)\nadmin.site.register(Chant, ChantAdmin)\nadmin.site.register(Differentia, DifferentiaAdmin)\nadmin.site.register(Feast, FeastAdmin)\nadmin.site.register(Genre, GenreAdmin)\nadmin.site.register(Notation, NotationAdmin)\nadmin.site.register(Office, OfficeAdmin)\nadmin.site.register(Provenance, ProvenanceAdmin)\nadmin.site.register(RismSiglum, RismSiglumAdmin)\nadmin.site.register(Segment, SegmentAdmin)\nadmin.site.register(Sequence, SequenceAdmin)\nadmin.site.register(Source, SourceAdmin)\n", "path": "django/cantusdb_project/main_app/admin.py" } ]	diff --git a/django/cantusdb_project/main_app/admin.py b/django/cantusdb_project/main_app/admin.py index 1049cd088..10a74b371 100644 --- a/django/cantusdb_project/main_app/admin.py +++ b/django/cantusdb_project/main_app/admin.py @@ -172,6 +172,8 @@ def get_source_siglum(self, obj): class SourceAdmin(BaseModelAdmin): + exclude = ("source_status",) + # These search fields are also available on the user-source inline relationship in the user admin page search_fields = ( "siglum",
learningequality__kolibri-6490	Importing more content (or deleting resources) to a channel undoes its original position in channel list <!-- Instructions: * Fill out the sections below, replace …'s with information about your issue * Use the 'preview' function above this text box to verify formatting before submitting --> ### Observed behavior ~Similar to #5292, if you import more content to a channel, it will always be moved to the bottom of the Device > Channel page even if you had given it a different order (or didn't reorder it but just imported it in the past at some point). Because a lot of places in the app use the same order, we also see #5292~ Edit: This has been resolved for Kolibri when using Sqlite, but when using Postgresl, what seems to happen is that the newly modified channel goes to the _top_ of the list. It's because the channel in this case falls into this branch: https://github.com/learningequality/kolibri/blob/0ee38838e5fc74d1f85b15c867f53ec4c261448c/kolibri/core/content/utils/annotation.py#L479-L482 ~A somewhat mitigating factor is that newly updated channels will temporarily be moved to the top of the channel and have a green "New" label attached to it, so it will be easy to find immediately after the import.~ ### Expected behavior Updating a channel doesn't move it to the ~"bottom"~ top of the channel list. ### User-facing consequences 1. Users will need to move the channel again 1. Users might not immediately realize the channel moved ### Errors and logs <!-- Relevant logs from: * the command line * ~/.kolibri/logs/kolibri.txt * the browser console Please wrap errors in triple backticks for clean formatting like this: ``` 01:10 info: something happened 01:12 error: something bad happened ``` --> … ### Steps to reproduce 1. Run Kolibri using Postgresql as DB 1. Run a similar scenario as described above ### Context Kolibri 0.13	[ { "content": "import datetime\nimport logging\nimport os\n\nfrom django.db.models import Sum\nfrom le_utils.constants import content_kinds\nfrom sqlalchemy import and_\nfrom sqlalchemy import cast\nfrom sqlalchemy import exists\nfrom sqlalchemy import func\nfrom sqlalchemy import Integer\nfrom sqlalchemy import select\n\nfrom .paths import get_content_file_name\nfrom .paths import get_content_storage_file_path\nfrom .sqlalchemybridge import Bridge\nfrom kolibri.core.content.apps import KolibriContentConfig\nfrom kolibri.core.content.errors import InvalidStorageFilenameError\nfrom kolibri.core.content.models import ChannelMetadata\nfrom kolibri.core.content.models import ContentNode\nfrom kolibri.core.content.models import File\nfrom kolibri.core.content.models import LocalFile\nfrom kolibri.core.device.models import ContentCacheKey\n\nlogger = logging.getLogger(__name__)\n\nCONTENT_APP_NAME = KolibriContentConfig.label\n\nCHUNKSIZE = 10000\n\n\ndef _MPTT_descendant_ids_statement(ContentNodeTable, node_ids):\n node_include = ContentNodeTable.alias()\n return select([ContentNodeTable.c.id]).where(\n and_(\n node_include.c.id.in_(node_ids),\n ContentNodeTable.c.lft >= node_include.c.lft,\n ContentNodeTable.c.lft <= node_include.c.rght,\n ContentNodeTable.c.tree_id == node_include.c.tree_id,\n )\n )\n\n\ndef set_leaf_nodes_invisible(channel_id, node_ids=None, exclude_node_ids=None):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n\n connection = bridge.get_connection()\n\n update_statement = ContentNodeTable.update().where(\n and_(\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n ContentNodeTable.c.channel_id == channel_id,\n )\n )\n\n if node_ids:\n node_ids_statement = _MPTT_descendant_ids_statement(ContentNodeTable, node_ids)\n update_statement = update_statement.where(\n ContentNodeTable.c.id.in_(node_ids_statement)\n )\n\n if exclude_node_ids:\n exclude_node_ids_statement = _MPTT_descendant_ids_statement(\n ContentNodeTable, exclude_node_ids\n )\n update_statement = update_statement.where(\n ~ContentNodeTable.c.id.in_(exclude_node_ids_statement)\n )\n\n connection.execute(\n update_statement.values(available=False).execution_options(autocommit=True)\n )\n\n bridge.end()\n\n\ndef set_leaf_node_availability_from_local_file_availability(\n channel_id, node_ids=None, exclude_node_ids=None\n):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n FileTable = bridge.get_table(File)\n LocalFileTable = bridge.get_table(LocalFile)\n\n connection = bridge.get_connection()\n\n contentnode_statement = (\n select([FileTable.c.contentnode_id])\n .select_from(\n FileTable.join(\n LocalFileTable,\n and_(\n FileTable.c.local_file_id == LocalFileTable.c.id,\n LocalFileTable.c.available == True, # noqa\n ),\n )\n )\n .where(FileTable.c.supplementary == False)\n .where(ContentNodeTable.c.id == FileTable.c.contentnode_id)\n )\n\n logger.info(\n \"Setting availability of non-topic ContentNode objects based on LocalFile availability\"\n )\n\n update_statement = ContentNodeTable.update().where(\n and_(\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n ContentNodeTable.c.channel_id == channel_id,\n )\n )\n\n if node_ids is not None:\n node_ids_statement = _MPTT_descendant_ids_statement(ContentNodeTable, node_ids)\n update_statement = update_statement.where(\n ContentNodeTable.c.id.in_(node_ids_statement)\n )\n\n if exclude_node_ids is not None:\n exclude_node_ids_statement = _MPTT_descendant_ids_statement(\n ContentNodeTable, exclude_node_ids\n )\n update_statement = update_statement.where(\n ~ContentNodeTable.c.id.in_(exclude_node_ids_statement)\n )\n\n connection.execute(\n update_statement.values(\n available=exists(contentnode_statement)\n ).execution_options(autocommit=True)\n )\n\n bridge.end()\n\n\ndef mark_local_files_as_unavailable(checksums, destination=None):\n mark_local_files_availability(checksums, False, destination=destination)\n\n\ndef mark_local_files_as_available(checksums, destination=None):\n \"\"\"\n Shortcut method to update database if we are sure that the files are available.\n Can be used after successful downloads to flag availability without having to do expensive disk reads.\n \"\"\"\n mark_local_files_availability(checksums, True, destination=destination)\n\n\ndef mark_local_files_availability(checksums, availability, destination=None):\n if checksums:\n bridge = Bridge(app_name=CONTENT_APP_NAME, sqlite_file_path=destination)\n\n LocalFileClass = bridge.get_class(LocalFile)\n\n logger.info(\n \"Setting availability to {availability} of {number} LocalFile objects based on passed in checksums\".format(\n number=len(checksums), availability=availability\n )\n )\n\n for i in range(0, len(checksums), CHUNKSIZE):\n bridge.session.bulk_update_mappings(\n LocalFileClass,\n (\n {\"id\": checksum, \"available\": availability}\n for checksum in checksums[i : i + CHUNKSIZE]\n ),\n )\n bridge.session.flush()\n\n bridge.session.commit()\n\n bridge.end()\n\n\ndef set_local_file_availability_from_disk(checksums=None, destination=None):\n bridge = Bridge(app_name=CONTENT_APP_NAME, sqlite_file_path=destination)\n\n LocalFileClass = bridge.get_class(LocalFile)\n\n if checksums is None:\n logger.info(\n \"Setting availability of LocalFile objects based on disk availability\"\n )\n files = bridge.session.query(\n LocalFileClass.id, LocalFileClass.available, LocalFileClass.extension\n ).all()\n elif type(checksums) == list:\n logger.info(\n \"Setting availability of {number} LocalFile objects based on disk availability\".format(\n number=len(checksums)\n )\n )\n files = (\n bridge.session.query(\n LocalFileClass.id, LocalFileClass.available, LocalFileClass.extension\n )\n .filter(LocalFileClass.id.in_(checksums))\n .all()\n )\n else:\n logger.info(\n \"Setting availability of LocalFile object with checksum {checksum} based on disk availability\".format(\n checksum=checksums\n )\n )\n files = [bridge.session.query(LocalFileClass).get(checksums)]\n\n checksums_to_set_available = []\n checksums_to_set_unavailable = []\n for file in files:\n try:\n # Update if the file exists, and the localfile is set as unavailable.\n if os.path.exists(\n get_content_storage_file_path(get_content_file_name(file))\n ):\n if not file.available:\n checksums_to_set_available.append(file.id)\n # Update if the file does not exist, and the localfile is set as available.\n else:\n if file.available:\n checksums_to_set_unavailable.append(file.id)\n except InvalidStorageFilenameError:\n continue\n\n bridge.end()\n\n mark_local_files_as_available(checksums_to_set_available, destination=destination)\n mark_local_files_as_unavailable(\n checksums_to_set_unavailable, destination=destination\n )\n\n\ndef recurse_annotation_up_tree(channel_id):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeClass = bridge.get_class(ContentNode)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n\n connection = bridge.get_connection()\n\n node_depth = (\n bridge.session.query(func.max(ContentNodeClass.level))\n .filter_by(channel_id=channel_id)\n .scalar()\n )\n\n logger.info(\n \"Annotating ContentNode objects with children for {levels} levels\".format(\n levels=node_depth\n )\n )\n\n child = ContentNodeTable.alias()\n\n # start a transaction\n\n trans = connection.begin()\n start = datetime.datetime.now()\n\n # Update all leaf ContentNodes to have num_coach_content to 1 or 0\n # Update all leaf ContentNodes to have on_device_resources to 1 or 0\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n # In this channel\n ContentNodeTable.c.channel_id == channel_id,\n # That are not topics\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n )\n )\n .values(\n num_coach_contents=cast(ContentNodeTable.c.coach_content, Integer()),\n on_device_resources=cast(ContentNodeTable.c.available, Integer()),\n )\n )\n\n # Before starting set availability to False on all topics.\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n # In this channel\n ContentNodeTable.c.channel_id == channel_id,\n # That are topics\n ContentNodeTable.c.kind == content_kinds.TOPIC,\n )\n )\n .values(available=False)\n )\n\n # Expression to capture all available child nodes of a contentnode\n available_nodes = select([child.c.available]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expressions for annotation of coach content\n\n # Expression that will resolve a boolean value for all the available children\n # of a content node, whereby if they all have coach_content flagged on them, it will be true,\n # but otherwise false.\n # Everything after the select statement should be identical to the available_nodes expression above.\n if bridge.engine.name == \"sqlite\":\n # Use a min function to simulate an AND.\n coach_content_nodes = select([func.min(child.c.coach_content)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n elif bridge.engine.name == \"postgresql\":\n # Use the postgres boolean AND operator\n coach_content_nodes = select([func.bool_and(child.c.coach_content)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expression that sums the total number of coach contents for each child node\n # of a contentnode\n coach_content_num = select([func.sum(child.c.num_coach_contents)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expression that sums the total number of on_device_resources for each child node\n # of a contentnode\n on_device_num = select([func.sum(child.c.on_device_resources)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Go from the deepest level to the shallowest\n for level in range(node_depth, 0, -1):\n\n logger.info(\n \"Annotating ContentNode objects with children for level {level}\".format(\n level=level\n )\n )\n # Only modify topic availability here\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n ContentNodeTable.c.level == level - 1,\n ContentNodeTable.c.channel_id == channel_id,\n ContentNodeTable.c.kind == content_kinds.TOPIC,\n )\n )\n # Because we have set availability to False on all topics as a starting point\n # we only need to make updates to topics with available children.\n .where(exists(available_nodes))\n .values(\n available=exists(available_nodes),\n coach_content=coach_content_nodes,\n num_coach_contents=coach_content_num,\n on_device_resources=on_device_num,\n )\n )\n\n # commit the transaction\n trans.commit()\n\n elapsed = datetime.datetime.now() - start\n logger.debug(\n \"Recursive topic tree annotation took {} seconds\".format(elapsed.seconds)\n )\n\n bridge.end()\n\n\ndef propagate_forced_localfile_removal(localfiles):\n files = File.objects.filter(supplementary=False, local_file__in=localfiles)\n ContentNode.objects.filter(files__in=files).update(available=False)\n for channel_id in ChannelMetadata.objects.all().values_list(\"id\", flat=True):\n recurse_annotation_up_tree(channel_id)\n\n\ndef update_content_metadata(\n channel_id, node_ids=None, exclude_node_ids=None, public=None\n):\n set_leaf_node_availability_from_local_file_availability(\n channel_id, node_ids=node_ids, exclude_node_ids=exclude_node_ids\n )\n recurse_annotation_up_tree(channel_id)\n set_channel_metadata_fields(channel_id, public=public)\n ContentCacheKey.update_cache_key()\n\n\ndef set_content_visibility(\n channel_id, checksums, node_ids=None, exclude_node_ids=None, public=None\n):\n mark_local_files_as_available(checksums)\n update_content_metadata(\n channel_id, node_ids=node_ids, exclude_node_ids=exclude_node_ids, public=public,\n )\n\n\ndef set_content_visibility_from_disk(channel_id):\n set_local_file_availability_from_disk()\n update_content_metadata(channel_id)\n\n\ndef set_content_invisible(channel_id, node_ids, exclude_node_ids):\n set_leaf_nodes_invisible(channel_id, node_ids, exclude_node_ids)\n recurse_annotation_up_tree(channel_id)\n set_channel_metadata_fields(channel_id)\n ContentCacheKey.update_cache_key()\n\n\ndef set_channel_metadata_fields(channel_id, public=None):\n channel = ChannelMetadata.objects.get(id=channel_id)\n calculate_published_size(channel)\n calculate_total_resource_count(channel)\n calculate_included_languages(channel)\n calculate_next_order(channel)\n\n if public is not None:\n channel.public = public\n channel.save()\n\n\ndef files_for_nodes(nodes):\n return LocalFile.objects.filter(files__contentnode__in=nodes)\n\n\ndef total_file_size(files_or_nodes):\n if issubclass(files_or_nodes.model, LocalFile):\n localfiles = files_or_nodes\n elif issubclass(files_or_nodes.model, ContentNode):\n localfiles = files_for_nodes(files_or_nodes)\n else:\n raise TypeError(\"Expected queryset for LocalFile or ContentNode\")\n return localfiles.distinct().aggregate(Sum(\"file_size\"))[\"file_size__sum\"] or 0\n\n\ndef calculate_published_size(channel):\n content_nodes = ContentNode.objects.filter(channel_id=channel.id)\n channel.published_size = total_file_size(\n files_for_nodes(content_nodes).filter(available=True)\n )\n channel.save()\n\n\ndef calculate_total_resource_count(channel):\n content_nodes = ContentNode.objects.filter(channel_id=channel.id)\n channel.total_resource_count = (\n content_nodes.filter(available=True)\n .exclude(kind=content_kinds.TOPIC)\n .dedupe_by_content_id()\n .count()\n )\n channel.save()\n\n\ndef calculate_included_languages(channel):\n content_nodes = ContentNode.objects.filter(\n channel_id=channel.id, available=True\n ).exclude(lang=None)\n languages = content_nodes.order_by(\"lang\").values_list(\"lang\", flat=True).distinct()\n channel.included_languages.add(*list(languages))\n\n\ndef calculate_next_order(channel, model=ChannelMetadata):\n latest_order = model.objects.latest(\"order\").order\n if latest_order is None:\n channel.order = 1\n else:\n channel.order = latest_order + 1\n channel.save()\n", "path": "kolibri/core/content/utils/annotation.py" } ]	[ { "content": "import datetime\nimport logging\nimport os\n\nfrom django.db.models import Sum\nfrom le_utils.constants import content_kinds\nfrom sqlalchemy import and_\nfrom sqlalchemy import cast\nfrom sqlalchemy import exists\nfrom sqlalchemy import func\nfrom sqlalchemy import Integer\nfrom sqlalchemy import select\n\nfrom .paths import get_content_file_name\nfrom .paths import get_content_storage_file_path\nfrom .sqlalchemybridge import Bridge\nfrom kolibri.core.content.apps import KolibriContentConfig\nfrom kolibri.core.content.errors import InvalidStorageFilenameError\nfrom kolibri.core.content.models import ChannelMetadata\nfrom kolibri.core.content.models import ContentNode\nfrom kolibri.core.content.models import File\nfrom kolibri.core.content.models import LocalFile\nfrom kolibri.core.device.models import ContentCacheKey\n\nlogger = logging.getLogger(__name__)\n\nCONTENT_APP_NAME = KolibriContentConfig.label\n\nCHUNKSIZE = 10000\n\n\ndef _MPTT_descendant_ids_statement(ContentNodeTable, node_ids):\n node_include = ContentNodeTable.alias()\n return select([ContentNodeTable.c.id]).where(\n and_(\n node_include.c.id.in_(node_ids),\n ContentNodeTable.c.lft >= node_include.c.lft,\n ContentNodeTable.c.lft <= node_include.c.rght,\n ContentNodeTable.c.tree_id == node_include.c.tree_id,\n )\n )\n\n\ndef set_leaf_nodes_invisible(channel_id, node_ids=None, exclude_node_ids=None):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n\n connection = bridge.get_connection()\n\n update_statement = ContentNodeTable.update().where(\n and_(\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n ContentNodeTable.c.channel_id == channel_id,\n )\n )\n\n if node_ids:\n node_ids_statement = _MPTT_descendant_ids_statement(ContentNodeTable, node_ids)\n update_statement = update_statement.where(\n ContentNodeTable.c.id.in_(node_ids_statement)\n )\n\n if exclude_node_ids:\n exclude_node_ids_statement = _MPTT_descendant_ids_statement(\n ContentNodeTable, exclude_node_ids\n )\n update_statement = update_statement.where(\n ~ContentNodeTable.c.id.in_(exclude_node_ids_statement)\n )\n\n connection.execute(\n update_statement.values(available=False).execution_options(autocommit=True)\n )\n\n bridge.end()\n\n\ndef set_leaf_node_availability_from_local_file_availability(\n channel_id, node_ids=None, exclude_node_ids=None\n):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n FileTable = bridge.get_table(File)\n LocalFileTable = bridge.get_table(LocalFile)\n\n connection = bridge.get_connection()\n\n contentnode_statement = (\n select([FileTable.c.contentnode_id])\n .select_from(\n FileTable.join(\n LocalFileTable,\n and_(\n FileTable.c.local_file_id == LocalFileTable.c.id,\n LocalFileTable.c.available == True, # noqa\n ),\n )\n )\n .where(FileTable.c.supplementary == False)\n .where(ContentNodeTable.c.id == FileTable.c.contentnode_id)\n )\n\n logger.info(\n \"Setting availability of non-topic ContentNode objects based on LocalFile availability\"\n )\n\n update_statement = ContentNodeTable.update().where(\n and_(\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n ContentNodeTable.c.channel_id == channel_id,\n )\n )\n\n if node_ids is not None:\n node_ids_statement = _MPTT_descendant_ids_statement(ContentNodeTable, node_ids)\n update_statement = update_statement.where(\n ContentNodeTable.c.id.in_(node_ids_statement)\n )\n\n if exclude_node_ids is not None:\n exclude_node_ids_statement = _MPTT_descendant_ids_statement(\n ContentNodeTable, exclude_node_ids\n )\n update_statement = update_statement.where(\n ~ContentNodeTable.c.id.in_(exclude_node_ids_statement)\n )\n\n connection.execute(\n update_statement.values(\n available=exists(contentnode_statement)\n ).execution_options(autocommit=True)\n )\n\n bridge.end()\n\n\ndef mark_local_files_as_unavailable(checksums, destination=None):\n mark_local_files_availability(checksums, False, destination=destination)\n\n\ndef mark_local_files_as_available(checksums, destination=None):\n \"\"\"\n Shortcut method to update database if we are sure that the files are available.\n Can be used after successful downloads to flag availability without having to do expensive disk reads.\n \"\"\"\n mark_local_files_availability(checksums, True, destination=destination)\n\n\ndef mark_local_files_availability(checksums, availability, destination=None):\n if checksums:\n bridge = Bridge(app_name=CONTENT_APP_NAME, sqlite_file_path=destination)\n\n LocalFileClass = bridge.get_class(LocalFile)\n\n logger.info(\n \"Setting availability to {availability} of {number} LocalFile objects based on passed in checksums\".format(\n number=len(checksums), availability=availability\n )\n )\n\n for i in range(0, len(checksums), CHUNKSIZE):\n bridge.session.bulk_update_mappings(\n LocalFileClass,\n (\n {\"id\": checksum, \"available\": availability}\n for checksum in checksums[i : i + CHUNKSIZE]\n ),\n )\n bridge.session.flush()\n\n bridge.session.commit()\n\n bridge.end()\n\n\ndef set_local_file_availability_from_disk(checksums=None, destination=None):\n bridge = Bridge(app_name=CONTENT_APP_NAME, sqlite_file_path=destination)\n\n LocalFileClass = bridge.get_class(LocalFile)\n\n if checksums is None:\n logger.info(\n \"Setting availability of LocalFile objects based on disk availability\"\n )\n files = bridge.session.query(\n LocalFileClass.id, LocalFileClass.available, LocalFileClass.extension\n ).all()\n elif type(checksums) == list:\n logger.info(\n \"Setting availability of {number} LocalFile objects based on disk availability\".format(\n number=len(checksums)\n )\n )\n files = (\n bridge.session.query(\n LocalFileClass.id, LocalFileClass.available, LocalFileClass.extension\n )\n .filter(LocalFileClass.id.in_(checksums))\n .all()\n )\n else:\n logger.info(\n \"Setting availability of LocalFile object with checksum {checksum} based on disk availability\".format(\n checksum=checksums\n )\n )\n files = [bridge.session.query(LocalFileClass).get(checksums)]\n\n checksums_to_set_available = []\n checksums_to_set_unavailable = []\n for file in files:\n try:\n # Update if the file exists, and the localfile is set as unavailable.\n if os.path.exists(\n get_content_storage_file_path(get_content_file_name(file))\n ):\n if not file.available:\n checksums_to_set_available.append(file.id)\n # Update if the file does not exist, and the localfile is set as available.\n else:\n if file.available:\n checksums_to_set_unavailable.append(file.id)\n except InvalidStorageFilenameError:\n continue\n\n bridge.end()\n\n mark_local_files_as_available(checksums_to_set_available, destination=destination)\n mark_local_files_as_unavailable(\n checksums_to_set_unavailable, destination=destination\n )\n\n\ndef recurse_annotation_up_tree(channel_id):\n bridge = Bridge(app_name=CONTENT_APP_NAME)\n\n ContentNodeClass = bridge.get_class(ContentNode)\n\n ContentNodeTable = bridge.get_table(ContentNode)\n\n connection = bridge.get_connection()\n\n node_depth = (\n bridge.session.query(func.max(ContentNodeClass.level))\n .filter_by(channel_id=channel_id)\n .scalar()\n )\n\n logger.info(\n \"Annotating ContentNode objects with children for {levels} levels\".format(\n levels=node_depth\n )\n )\n\n child = ContentNodeTable.alias()\n\n # start a transaction\n\n trans = connection.begin()\n start = datetime.datetime.now()\n\n # Update all leaf ContentNodes to have num_coach_content to 1 or 0\n # Update all leaf ContentNodes to have on_device_resources to 1 or 0\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n # In this channel\n ContentNodeTable.c.channel_id == channel_id,\n # That are not topics\n ContentNodeTable.c.kind != content_kinds.TOPIC,\n )\n )\n .values(\n num_coach_contents=cast(ContentNodeTable.c.coach_content, Integer()),\n on_device_resources=cast(ContentNodeTable.c.available, Integer()),\n )\n )\n\n # Before starting set availability to False on all topics.\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n # In this channel\n ContentNodeTable.c.channel_id == channel_id,\n # That are topics\n ContentNodeTable.c.kind == content_kinds.TOPIC,\n )\n )\n .values(available=False)\n )\n\n # Expression to capture all available child nodes of a contentnode\n available_nodes = select([child.c.available]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expressions for annotation of coach content\n\n # Expression that will resolve a boolean value for all the available children\n # of a content node, whereby if they all have coach_content flagged on them, it will be true,\n # but otherwise false.\n # Everything after the select statement should be identical to the available_nodes expression above.\n if bridge.engine.name == \"sqlite\":\n # Use a min function to simulate an AND.\n coach_content_nodes = select([func.min(child.c.coach_content)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n elif bridge.engine.name == \"postgresql\":\n # Use the postgres boolean AND operator\n coach_content_nodes = select([func.bool_and(child.c.coach_content)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expression that sums the total number of coach contents for each child node\n # of a contentnode\n coach_content_num = select([func.sum(child.c.num_coach_contents)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Expression that sums the total number of on_device_resources for each child node\n # of a contentnode\n on_device_num = select([func.sum(child.c.on_device_resources)]).where(\n and_(\n child.c.available == True, # noqa\n ContentNodeTable.c.id == child.c.parent_id,\n )\n )\n\n # Go from the deepest level to the shallowest\n for level in range(node_depth, 0, -1):\n\n logger.info(\n \"Annotating ContentNode objects with children for level {level}\".format(\n level=level\n )\n )\n # Only modify topic availability here\n connection.execute(\n ContentNodeTable.update()\n .where(\n and_(\n ContentNodeTable.c.level == level - 1,\n ContentNodeTable.c.channel_id == channel_id,\n ContentNodeTable.c.kind == content_kinds.TOPIC,\n )\n )\n # Because we have set availability to False on all topics as a starting point\n # we only need to make updates to topics with available children.\n .where(exists(available_nodes))\n .values(\n available=exists(available_nodes),\n coach_content=coach_content_nodes,\n num_coach_contents=coach_content_num,\n on_device_resources=on_device_num,\n )\n )\n\n # commit the transaction\n trans.commit()\n\n elapsed = datetime.datetime.now() - start\n logger.debug(\n \"Recursive topic tree annotation took {} seconds\".format(elapsed.seconds)\n )\n\n bridge.end()\n\n\ndef propagate_forced_localfile_removal(localfiles):\n files = File.objects.filter(supplementary=False, local_file__in=localfiles)\n ContentNode.objects.filter(files__in=files).update(available=False)\n for channel_id in ChannelMetadata.objects.all().values_list(\"id\", flat=True):\n recurse_annotation_up_tree(channel_id)\n\n\ndef update_content_metadata(\n channel_id, node_ids=None, exclude_node_ids=None, public=None\n):\n set_leaf_node_availability_from_local_file_availability(\n channel_id, node_ids=node_ids, exclude_node_ids=exclude_node_ids\n )\n recurse_annotation_up_tree(channel_id)\n set_channel_metadata_fields(channel_id, public=public)\n ContentCacheKey.update_cache_key()\n\n\ndef set_content_visibility(\n channel_id, checksums, node_ids=None, exclude_node_ids=None, public=None\n):\n mark_local_files_as_available(checksums)\n update_content_metadata(\n channel_id, node_ids=node_ids, exclude_node_ids=exclude_node_ids, public=public,\n )\n\n\ndef set_content_visibility_from_disk(channel_id):\n set_local_file_availability_from_disk()\n update_content_metadata(channel_id)\n\n\ndef set_content_invisible(channel_id, node_ids, exclude_node_ids):\n set_leaf_nodes_invisible(channel_id, node_ids, exclude_node_ids)\n recurse_annotation_up_tree(channel_id)\n set_channel_metadata_fields(channel_id)\n ContentCacheKey.update_cache_key()\n\n\ndef set_channel_metadata_fields(channel_id, public=None):\n channel = ChannelMetadata.objects.get(id=channel_id)\n calculate_published_size(channel)\n calculate_total_resource_count(channel)\n calculate_included_languages(channel)\n calculate_next_order(channel)\n\n if public is not None:\n channel.public = public\n channel.save()\n\n\ndef files_for_nodes(nodes):\n return LocalFile.objects.filter(files__contentnode__in=nodes)\n\n\ndef total_file_size(files_or_nodes):\n if issubclass(files_or_nodes.model, LocalFile):\n localfiles = files_or_nodes\n elif issubclass(files_or_nodes.model, ContentNode):\n localfiles = files_for_nodes(files_or_nodes)\n else:\n raise TypeError(\"Expected queryset for LocalFile or ContentNode\")\n return localfiles.distinct().aggregate(Sum(\"file_size\"))[\"file_size__sum\"] or 0\n\n\ndef calculate_published_size(channel):\n content_nodes = ContentNode.objects.filter(channel_id=channel.id)\n channel.published_size = total_file_size(\n files_for_nodes(content_nodes).filter(available=True)\n )\n channel.save()\n\n\ndef calculate_total_resource_count(channel):\n content_nodes = ContentNode.objects.filter(channel_id=channel.id)\n channel.total_resource_count = (\n content_nodes.filter(available=True)\n .exclude(kind=content_kinds.TOPIC)\n .dedupe_by_content_id()\n .count()\n )\n channel.save()\n\n\ndef calculate_included_languages(channel):\n content_nodes = ContentNode.objects.filter(\n channel_id=channel.id, available=True\n ).exclude(lang=None)\n languages = content_nodes.order_by(\"lang\").values_list(\"lang\", flat=True).distinct()\n channel.included_languages.add(*list(languages))\n\n\ndef calculate_next_order(channel, model=ChannelMetadata):\n latest_order = model.objects.latest(\"order\").order\n if latest_order is None:\n channel.order = 1\n\n if channel.order is None or channel.order == 0:\n channel.order = latest_order + 1\n\n channel.save()\n", "path": "kolibri/core/content/utils/annotation.py" } ]	diff --git a/kolibri/core/content/utils/annotation.py b/kolibri/core/content/utils/annotation.py index f06a9c1e09c..c2c6f3d0924 100644 --- a/kolibri/core/content/utils/annotation.py +++ b/kolibri/core/content/utils/annotation.py @@ -478,6 +478,8 @@ def calculate_next_order(channel, model=ChannelMetadata): latest_order = model.objects.latest("order").order if latest_order is None: channel.order = 1 - else: + + if channel.order is None or channel.order == 0: channel.order = latest_order + 1 + channel.save()
rlworkgroup__garage-692	Add Intel-optimized version of the package	[ { "content": "from setuptools import find_packages\nfrom setuptools import setup\n\n# Required dependencies\nrequired = [\n # Please keep alphabetized\n 'akro',\n 'boto3',\n 'cached_property',\n 'click',\n 'cloudpickle',\n 'cma==1.1.06',\n # dm_control throws an error during install about not being able to\n # find a build dependency (absl-py). Later pip executes the `install`\n # command again and the install succeeds because absl-py has been\n # installed. This is stupid, but harmless.\n 'dm_control @ https://api.github.com/repos/deepmind/dm_control/tarball/92f9913013face0468442cd0964d5973ea2089ea', # noqa: E501\n 'dowel==0.0.2',\n 'gym[all]==0.10.11',\n 'joblib<0.13,>=0.12',\n 'matplotlib',\n 'mujoco-py<1.50.2,>=1.50.1',\n 'numpy==1.14.5',\n 'psutil',\n 'pyprind',\n 'python-dateutil',\n 'scikit-image',\n 'scipy',\n 'tensorflow<1.13,>=1.12.0',\n 'tensorflow-probability<0.6.0,>=0.5.0', # for tensorflow 1.12\n]\n\n# Dependencies for optional features\nextras = {}\nextras['all'] = list(set(sum(extras.values(), [])))\n\n# Development dependencies (not included in \"all\")\nextras['dev'] = [\n # Please keep alphabetized\n 'baselines @ https://api.github.com/repos/openai/baselines/tarball/f2729693253c0ef4d4086231d36e0a4307ec1cb3', # noqa: E501\n 'coverage',\n 'flake8',\n 'flake8-docstrings==1.3.0',\n 'flake8-import-order',\n 'nose2',\n 'pandas',\n 'pep8-naming==0.7.0',\n 'pre-commit',\n 'pylint==1.9.2',\n 'sphinx',\n 'sphinx_rtd_theme',\n 'yapf',\n]\n\nwith open('README.md') as f:\n readme = f.read()\n\n# Get the package version dynamically\nwith open('VERSION') as v:\n version = v.read().strip()\n\nsetup(\n name='garage',\n version=version,\n author='Reinforcement Learning Working Group',\n description='A framework for reproducible reinforcement learning research',\n url='https://github.com/rlworkgroup/garage',\n packages=find_packages(where='src'),\n package_dir={'': 'src'},\n scripts=['scripts/garage'],\n install_requires=required,\n extras_require=extras,\n license='MIT',\n long_description=readme,\n long_description_content_type='text/markdown',\n classifiers=[\n 'Development Status :: 4 - Beta',\n 'Intended Audience :: Developers',\n 'Intended Audience :: Education',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3 :: Only',\n 'Topic :: Scientific/Engineering :: Artificial Intelligence',\n 'Topic :: Scientific/Engineering :: Mathematics',\n 'Topic :: Software Development :: Libraries',\n ],\n)\n", "path": "setup.py" } ]	[ { "content": "from setuptools import find_packages\nfrom setuptools import setup\n\n# Required dependencies\nrequired = [\n # Please keep alphabetized\n 'akro',\n 'boto3',\n 'cached_property',\n 'click',\n 'cloudpickle',\n 'cma==1.1.06',\n # dm_control throws an error during install about not being able to\n # find a build dependency (absl-py). Later pip executes the `install`\n # command again and the install succeeds because absl-py has been\n # installed. This is stupid, but harmless.\n 'dm_control @ https://api.github.com/repos/deepmind/dm_control/tarball/92f9913013face0468442cd0964d5973ea2089ea', # noqa: E501\n 'dowel==0.0.2',\n 'gym[all]==0.10.11',\n 'joblib<0.13,>=0.12',\n 'matplotlib',\n 'mujoco-py<1.50.2,>=1.50.1',\n 'numpy==1.14.5',\n 'psutil',\n 'pyprind',\n 'python-dateutil',\n 'scikit-image',\n 'scipy',\n 'tensorflow<1.13,>=1.12.0',\n 'tensorflow-probability<0.6.0,>=0.5.0', # for tensorflow 1.12\n]\n\n# Dependencies for optional features\nextras = {}\nextras['all'] = list(set(sum(extras.values(), [])))\n\n# Intel dependencies not included in all\nextras['intel'] = ['intel-tensorflow<1.13,>=1.12.0']\n\n# Development dependencies (not included in \"all\")\nextras['dev'] = [\n # Please keep alphabetized\n 'baselines @ https://api.github.com/repos/openai/baselines/tarball/f2729693253c0ef4d4086231d36e0a4307ec1cb3', # noqa: E501\n 'coverage',\n 'flake8',\n 'flake8-docstrings==1.3.0',\n 'flake8-import-order',\n 'nose2',\n 'pandas',\n 'pep8-naming==0.7.0',\n 'pre-commit',\n 'pylint==1.9.2',\n 'sphinx',\n 'sphinx_rtd_theme',\n 'yapf',\n]\n\nwith open('README.md') as f:\n readme = f.read()\n\n# Get the package version dynamically\nwith open('VERSION') as v:\n version = v.read().strip()\n\nsetup(\n name='garage',\n version=version,\n author='Reinforcement Learning Working Group',\n description='A framework for reproducible reinforcement learning research',\n url='https://github.com/rlworkgroup/garage',\n packages=find_packages(where='src'),\n package_dir={'': 'src'},\n scripts=['scripts/garage'],\n install_requires=required,\n extras_require=extras,\n license='MIT',\n long_description=readme,\n long_description_content_type='text/markdown',\n classifiers=[\n 'Development Status :: 4 - Beta',\n 'Intended Audience :: Developers',\n 'Intended Audience :: Education',\n 'Intended Audience :: Science/Research',\n 'License :: OSI Approved :: MIT License',\n 'Programming Language :: Python :: 3.5',\n 'Programming Language :: Python :: 3.6',\n 'Programming Language :: Python :: 3.7',\n 'Programming Language :: Python :: 3 :: Only',\n 'Topic :: Scientific/Engineering :: Artificial Intelligence',\n 'Topic :: Scientific/Engineering :: Mathematics',\n 'Topic :: Software Development :: Libraries',\n ],\n)\n", "path": "setup.py" } ]	diff --git a/Makefile b/Makefile index 66b971f473..1b95fa4c68 100644 --- a/Makefile +++ b/Makefile @@ -67,6 +67,14 @@ build-nvidia: docker/docker-compose-nvidia.yml build \ ${ADD_ARGS} +build-intel: TAG ?= rlworkgroup/garage-intel:latest +build-intel: docker/docker-compose-intel.yml + TAG=${TAG} \ + docker-compose \ + -f docker/docker-compose-intel.yml \ + build \ + ${ADD_ARGS} + run-ci: ## Run the CI Docker container (only used in TravisCI) run-ci: TAG ?= rlworkgroup/garage-ci run-ci: @@ -108,6 +116,22 @@ run-nvidia: build-nvidia ${ADD_ARGS} \ rlworkgroup/garage-nvidia $(RUN_CMD) +run-intel: ## Run the Docker container for machines with Intel CPUs +run-intel: CONTAINER_NAME ?= garage-intel +run-intel: build-intel + xhost +local:docker + docker run \ + -it \ + --rm \ + -v /tmp/.X11-unix:/tmp/.X11-unix \ + -v $(DATA_PATH)/$(CONTAINER_NAME):/root/code/garage/data \ + -e DISPLAY=$(DISPLAY) \ + -e QT_X11_NO_MITSHM=1 \ + -e MJKEY="$$(cat $(MJKEY_PATH))" \ + --name $(CONTAINER_NAME) \ + ${ADD_ARGS} \ + rlworkgroup/garage-intel $(RUN_CMD) + # Help target # See https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html diff --git a/docker/Dockerfile.intel b/docker/Dockerfile.intel new file mode 100644 index 0000000000..5324012451 --- /dev/null +++ b/docker/Dockerfile.intel @@ -0,0 +1,8 @@ +ARG PARENT_IMAGE=rlworkgroup/garage-base +FROM $PARENT_IMAGE + +WORKDIR /root/code/garage +RUN ["/bin/bash", "-c", "source activate garage && pip install -e .[intel]"] + +# Ready, set, go. +ENTRYPOINT ["docker/entrypoint-runtime.sh"] diff --git a/docker/Dockerfile.nvidia b/docker/Dockerfile.nvidia index a90cceb127..582c1aab2f 100644 --- a/docker/Dockerfile.nvidia +++ b/docker/Dockerfile.nvidia @@ -2,4 +2,4 @@ ARG PARENT_IMAGE=rlworkgroup/garage-base FROM $PARENT_IMAGE # Ready, set, go. -ENTRYPOINT ["docker/entrypoint-nvidia.sh"] +ENTRYPOINT ["docker/entrypoint-runtime.sh"] diff --git a/docker/docker-compose-intel.yml b/docker/docker-compose-intel.yml new file mode 100644 index 0000000000..82908cc542 --- /dev/null +++ b/docker/docker-compose-intel.yml @@ -0,0 +1,27 @@ +version: '2.2' +services: + garage-base: + build: + cache_from: + - rlworkgroup/garage-intel:latest + context: ../ + dockerfile: docker/Dockerfile.base + image: rlworkgroup/garage-base + garage-intel-no-files: + build: + cache_from: + - rlworkgroup/garage-intel:latest + context: ../ + dockerfile: docker/Dockerfile.intel + args: + - PARENT_IMAGE=rlworkgroup/garage-base + image: rlworkgroup/garage-intel-no-files + garage-intel: + build: + cache_from: + - rlworkgroup/garage-intel:latest + context: ../ + dockerfile: docker/Dockerfile.runtime + args: + - PARENT_IMAGE=rlworkgroup/garage-intel-no-files + image: ${TAG} diff --git a/docker/entrypoint-nvidia.sh b/docker/entrypoint-runtime.sh similarity index 100% rename from docker/entrypoint-nvidia.sh rename to docker/entrypoint-runtime.sh diff --git a/setup.py b/setup.py index 9c526a0ad1..89b99caee9 100644 --- a/setup.py +++ b/setup.py @@ -34,6 +34,9 @@ extras = {} extras['all'] = list(set(sum(extras.values(), []))) +# Intel dependencies not included in all +extras['intel'] = ['intel-tensorflow<1.13,>=1.12.0'] + # Development dependencies (not included in "all") extras['dev'] = [ # Please keep alphabetized
ansible__ansible-modules-extras-3479	Remove ESXi hostname requirement from vmware_guest module ##### ISSUE TYPE - Feature Idea ##### COMPONENT NAME vmware_guest ##### ANSIBLE VERSION ``` ansible 2.3.0.0 config file = /etc/ansible/ansible.cfg configured module search path = Default w/o overrides ``` ##### CONFIGURATION <!--- Vanilla --> ##### OS / ENVIRONMENT <!--- N/A (Ubuntu Yakkety) --> ##### SUMMARY When using VMWare vCenter either via the GUI or powershell, vCenter itself is the mechanism by which your destination ESXi host is chosen yet this vmware_guest ansible module is requiring you to manually specify the destination ESXi host which completely defeats the purpose of vCenter and DRS balancing and forces you to do some nasty hacks to work around it. ##### STEPS TO REPRODUCE <!--- The new feature should be able to offload the decision of what ESXi host your new virtual machine ends up on based on parameters passed to vCenter such as vCenter server name, cluster, destination folder etc similarly to how it works in PowerCLI/Powershell currently. We should be specifying the chosen data store, VLAN etc in the playbook, however the destination ESXi host in a vCenter environment should be 100% vCenter's decision and not having to be specified manually. -->	[ { "content": "#!/usr/bin/python\n# -- coding: utf-8 --\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# Ansible is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\n\nDOCUMENTATION = '''\n---\nmodule: vmware_guest\nshort_description: Manages virtualmachines in vcenter\ndescription:\n - Uses pyvmomi to ...\n - copy a template to a new virtualmachine\n - poweron/poweroff/restart a virtualmachine\n - remove a virtualmachine\nversion_added: 2.2\nauthor: James Tanner (@jctanner) <[email protected]>\nnotes:\n - Tested on vSphere 6.0\nrequirements:\n - \"python >= 2.6\"\n - PyVmomi\noptions:\n state:\n description:\n - What state should the virtualmachine be in?\n required: True\n choices: ['present', 'absent', 'poweredon', 'poweredoff', 'restarted', 'suspended']\n name:\n description:\n - Name of the newly deployed guest\n required: True\n name_match:\n description:\n - If multiple vms matching the name, use the first or last found \n required: False\n default: 'first'\n choices: ['first', 'last']\n uuid:\n description:\n - UUID of the instance to manage if known, this is vmware's unique identifier.\n - This is required if name is not supplied.\n required: False\n template:\n description:\n - Name of the template to deploy, if needed to create the guest (state=present).\n - If the guest exists already this setting will be ignored.\n required: False\n folder:\n description:\n - Destination folder path for the new guest\n required: False\n hardware:\n description:\n - Attributes such as cpus, memory, osid, and disk controller\n required: False\n disk:\n description:\n - A list of disks to add\n required: False\n nic:\n description:\n - A list of nics to add\n required: False\n wait_for_ip_address:\n description:\n - Wait until vcenter detects an IP address for the guest\n required: False\n force:\n description:\n - Ignore warnings and complete the actions\n required: False\n datacenter:\n description:\n - Destination datacenter for the deploy operation\n required: True\n esxi_hostname:\n description:\n - The esxi hostname where the VM will run.\n required: True\n annotation:\n description:\n - A note or annotation to include in the VM\n required: False\n version_added: \"2.3\"\n customize:\n description:\n - Should customization spec be run\n required: False\n version_added: \"2.3\"\n ips:\n description:\n - IP Addresses to set\n required: False\n version_added: \"2.3\"\n networks: \n description:\n - Network to use should include VM network name and gateway\n required: False\n version_added: \"2.3\"\n dns_servers:\n description:\n - DNS servers to use\n required: False\n version_added: \"2.3\"\n domain: \n description:\n - Domain to use while customizing\n required: False\n version_added: \"2.3\"\n snapshot_op:\n description:\n - A key, value pair of snapshot operation types and their additional required parameters.\n required: False\n version_added: \"2.3\"\nextends_documentation_fragment: vmware.documentation \n'''\n\nEXAMPLES = '''\nExample from Ansible playbook\n#\n# Create a VM from a template\n#\n - name: create the VM\n vmware_guest:\n validate_certs: False\n hostname: 192.0.2.44\n username: [email protected]\n password: vmware\n name: testvm_2\n state: poweredon\n folder: testvms\n disk:\n - size_gb: 10\n type: thin\n datastore: g73_datastore\n nic:\n - type: vmxnet3\n network: VM Network\n network_type: standard\n hardware:\n memory_mb: 512\n num_cpus: 1\n osid: centos64guest\n scsi: paravirtual\n datacenter: datacenter1\n esxi_hostname: 192.0.2.117\n template: template_el7\n wait_for_ip_address: yes\n register: deploy\n\n#\n# Clone Template and customize\n#\n - name: Clone template and customize\n vmware_guest:\n hostname: \"192.168.1.209\"\n username: \"[email protected]\"\n password: \"vmware\"\n validate_certs: False\n name: testvm-2\n datacenter: datacenter1\n cluster: cluster\n validate_certs: False\n template: template_el7\n customize: True\n domain: \"example.com\"\n dns_servers: ['192.168.1.1','192.168.1.2']\n ips: \"192.168.1.100\"\n networks:\n '192.168.1.0/24':\n network: 'VM Network'\n gateway: '192.168.1.1' \n#\n# Gather facts only\n#\n - name: gather the VM facts\n vmware_guest:\n validate_certs: False\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n name: testvm_2\n esxi_hostname: 192.168.1.117\n register: facts\n\n### Snapshot Operations\n# Create snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: create\n name: snap1\n description: snap1_description\n\n# Remove a snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: remove\n name: snap1\n\n# Revert to a snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: revert\n name: snap1\n\n# List all snapshots of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: list_all\n\n# List current snapshot of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: list_current\n\n# Remove all snapshots of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: remove_all\n'''\n\nRETURN = \"\"\"\ninstance:\n descripton: metadata about the new virtualmachine\n returned: always\n type: dict\n sample: None\n\"\"\"\n\ntry:\n import json\nexcept ImportError:\n import simplejson as json\n\nHAS_PYVMOMI = False\ntry:\n import pyVmomi\n from pyVmomi import vim\n HAS_PYVMOMI = True\nexcept ImportError:\n pass\n\nimport os\nimport time\nfrom netaddr import IPNetwork, IPAddress\n\nfrom ansible.module_utils.urls import fetch_url\n\nclass PyVmomiHelper(object):\n\n def __init__(self, module):\n\n if not HAS_PYVMOMI:\n module.fail_json(msg='pyvmomi module required')\n\n self.module = module\n self.params = module.params\n self.si = None\n self.smartconnect()\n self.datacenter = None\n self.folders = None\n self.foldermap = None\n\n def smartconnect(self):\n self.content = connect_to_api(self.module)\n\n def _build_folder_tree(self, folder, tree={}, treepath=None):\n\n tree = {'virtualmachines': [],\n 'subfolders': {},\n 'vimobj': folder,\n 'name': folder.name}\n\n children = None\n if hasattr(folder, 'childEntity'):\n children = folder.childEntity\n\n if children:\n for child in children:\n if child == folder or child in tree:\n continue\n if isinstance(child, vim.Folder):\n ctree = self._build_folder_tree(child)\n tree['subfolders'][child] = dict.copy(ctree)\n elif isinstance(child, vim.VirtualMachine):\n tree['virtualmachines'].append(child)\n else:\n if isinstance(folder, vim.VirtualMachine):\n return folder\n return tree\n\n\n def _build_folder_map(self, folder, vmap={}, inpath='/'):\n\n ''' Build a searchable index for vms+uuids+folders '''\n\n if isinstance(folder, tuple):\n folder = folder[1]\n\n if not 'names' in vmap:\n vmap['names'] = {}\n if not 'uuids' in vmap:\n vmap['uuids'] = {}\n if not 'paths' in vmap:\n vmap['paths'] = {}\n\n if inpath == '/':\n thispath = '/vm'\n else:\n thispath = os.path.join(inpath, folder['name'])\n\n if thispath not in vmap['paths']:\n vmap['paths'][thispath] = []\n\n # helpful for isolating folder objects later on\n if not 'path_by_fvim' in vmap:\n vmap['path_by_fvim'] = {}\n if not 'fvim_by_path' in vmap:\n vmap['fvim_by_path'] = {}\n # store object by path and store path by object\n vmap['fvim_by_path'][thispath] = folder['vimobj']\n vmap['path_by_fvim'][folder['vimobj']] = thispath\n\n # helpful for isolating vm objects later on\n if not 'path_by_vvim' in vmap:\n vmap['path_by_vvim'] = {}\n if not 'vvim_by_path' in vmap:\n vmap['vvim_by_path'] = {}\n if thispath not in vmap['vvim_by_path']:\n vmap['vvim_by_path'][thispath] = []\n \n\n for item in folder.items():\n k = item[0]\n v = item[1]\n\n if k == 'name':\n pass\n elif k == 'subfolders':\n for x in v.items():\n vmap = self._build_folder_map(x, vmap=vmap, inpath=thispath)\n elif k == 'virtualmachines':\n for x in v:\n if not x.config.name in vmap['names']:\n vmap['names'][x.config.name] = []\n vmap['names'][x.config.name].append(x.config.uuid)\n vmap['uuids'][x.config.uuid] = x.config.name\n vmap['paths'][thispath].append(x.config.uuid)\n\n if x not in vmap['vvim_by_path'][thispath]:\n vmap['vvim_by_path'][thispath].append(x)\n if x not in vmap['path_by_vvim']:\n vmap['path_by_vvim'][x] = thispath\n return vmap\n\n def getfolders(self):\n\n if not self.datacenter:\n self.get_datacenter()\n self.folders = self._build_folder_tree(self.datacenter.vmFolder)\n self.folder_map = self._build_folder_map(self.folders)\n return (self.folders, self.folder_map)\n\n def compile_folder_path_for_object(self, vobj):\n ''' make a /vm/foo/bar/baz like folder path for an object '''\n paths = []\n if isinstance(vobj, vim.Folder):\n paths.append(vobj.name)\n\n thisobj = vobj\n while hasattr(thisobj, 'parent'):\n thisobj = thisobj.parent\n if isinstance(thisobj, vim.Folder):\n paths.append(thisobj.name)\n paths.reverse()\n if paths[0] == 'Datacenters':\n paths.remove('Datacenters')\n return '/' + '/'.join(paths)\n\n def get_datacenter(self):\n self.datacenter = get_obj(self.content, [vim.Datacenter], \n self.params['datacenter'])\n\n def getvm(self, name=None, uuid=None, folder=None, name_match=None):\n\n # https://www.vmware.com/support/developer/vc-sdk/visdk2xpubs/ReferenceGuide/vim.SearchIndex.html\n # self.si.content.searchIndex.FindByInventoryPath('DC1/vm/test_folder')\n\n vm = None\n folder_path = None\n searchpath = None\n\n if uuid:\n vm = self.content.searchIndex.FindByUuid(uuid=uuid, vmSearch=True)\n\n elif folder:\n\n if self.params['folder'].endswith('/'):\n self.params['folder'] = self.params['folder'][0:-1]\n\n # Build the absolute folder path to pass into the search method\n if self.params['folder'].startswith('/vm'):\n searchpath = '%s' % self.params['datacenter']\n searchpath += self.params['folder']\n elif self.params['folder'].startswith('/'):\n searchpath = '%s' % self.params['datacenter']\n searchpath += '/vm' + self.params['folder']\n else:\n # need to look for matching absolute path\n if not self.folders:\n self.getfolders()\n paths = self.folder_map['paths'].keys()\n paths = [x for x in paths if x.endswith(self.params['folder'])]\n if len(paths) > 1:\n self.module.fail_json(msg='%s matches more than one folder. Please use the absolute path starting with /vm/' % self.params['folder'])\n elif paths:\n searchpath = paths[0]\n\n if searchpath:\n # get all objects for this path ...\n fObj = self.content.searchIndex.FindByInventoryPath(searchpath)\n if fObj:\n if isinstance(fObj, vim.Datacenter):\n fObj = fObj.vmFolder\n for cObj in fObj.childEntity:\n if not isinstance(cObj, vim.VirtualMachine):\n continue\n if cObj.name == name:\n vm = cObj\n break\n\n if not vm:\n\n # FIXME - this is unused if folder has a default value\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n\n # narrow down by folder\n if folder:\n if not self.folders:\n self.getfolders()\n\n # compare the folder path of each VM against the search path\n for item in vmList.items():\n vobj = item[0]\n if not isinstance(vobj.parent, vim.Folder):\n continue\n if self.compile_folder_path_for_object(vobj) == searchpath:\n return vobj\n\n if name_match:\n if name_match == 'first':\n vm = get_obj(self.content, [vim.VirtualMachine], name)\n elif name_match == 'last':\n matches = []\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n for thisvm in vmList:\n if thisvm.config.name == name:\n matches.append(thisvm)\n if matches:\n vm = matches[-1]\n else: \n matches = []\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n for thisvm in vmList:\n if thisvm.config.name == name:\n matches.append(thisvm)\n if len(matches) > 1:\n module.fail_json(msg='more than 1 vm exists by the name %s. Please specify a uuid, or a folder, or a datacenter or name_match' % name)\n if matches:\n vm = matches[0]\n\n return vm\n\n\n def set_powerstate(self, vm, state, force):\n \"\"\"\n Set the power status for a VM determined by the current and\n requested states. force is forceful\n \"\"\"\n facts = self.gather_facts(vm)\n expected_state = state.replace('_', '').lower()\n current_state = facts['hw_power_status'].lower()\n result = {}\n\n # Need Force\n if not force and current_state not in ['poweredon', 'poweredoff']:\n return \"VM is in %s power state. Force is required!\" % current_state\n\n # State is already true\n if current_state == expected_state:\n result['changed'] = False\n result['failed'] = False\n else:\n task = None\n try:\n if expected_state == 'poweredoff':\n task = vm.PowerOff()\n\n elif expected_state == 'poweredon':\n task = vm.PowerOn()\n\n elif expected_state == 'restarted':\n if current_state in ('poweredon', 'poweringon', 'resetting'):\n task = vm.Reset()\n else:\n result = {'changed': False, 'failed': True, \n 'msg': \"Cannot restart VM in the current state %s\" % current_state}\n\n except Exception:\n result = {'changed': False, 'failed': True, \n 'msg': get_exception()}\n\n if task:\n self.wait_for_task(task)\n if task.info.state == 'error':\n result = {'changed': False, 'failed': True, 'msg': task.info.error.msg}\n else:\n result = {'changed': True, 'failed': False}\n\n # need to get new metadata if changed\n if result['changed']:\n newvm = self.getvm(uuid=vm.config.uuid)\n facts = self.gather_facts(newvm)\n result['instance'] = facts\n return result\n\n\n def gather_facts(self, vm):\n\n ''' Gather facts from vim.VirtualMachine object. '''\n\n facts = {\n 'module_hw': True,\n 'hw_name': vm.config.name,\n 'hw_power_status': vm.summary.runtime.powerState,\n 'hw_guest_full_name': vm.summary.guest.guestFullName,\n 'hw_guest_id': vm.summary.guest.guestId,\n 'hw_product_uuid': vm.config.uuid,\n 'hw_processor_count': vm.config.hardware.numCPU,\n 'hw_memtotal_mb': vm.config.hardware.memoryMB,\n 'hw_interfaces':[],\n 'ipv4': None,\n 'ipv6': None,\n }\n\n netDict = {}\n for device in vm.guest.net:\n mac = device.macAddress\n ips = list(device.ipAddress)\n netDict[mac] = ips\n for k,v in netDict.iteritems():\n for ipaddress in v:\n if ipaddress:\n if '::' in ipaddress:\n facts['ipv6'] = ipaddress\n else:\n facts['ipv4'] = ipaddress\n\n for idx,entry in enumerate(vm.config.hardware.device):\n if not hasattr(entry, 'macAddress'):\n continue\n\n factname = 'hw_eth' + str(idx)\n facts[factname] = {\n 'addresstype': entry.addressType,\n 'label': entry.deviceInfo.label,\n 'macaddress': entry.macAddress,\n 'ipaddresses': netDict.get(entry.macAddress, None),\n 'macaddress_dash': entry.macAddress.replace(':', '-'),\n 'summary': entry.deviceInfo.summary,\n }\n facts['hw_interfaces'].append('eth'+str(idx))\n\n return facts\n\n\n def remove_vm(self, vm):\n # https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.ManagedEntity.html#destroy\n task = vm.Destroy()\n self.wait_for_task(task)\n\n if task.info.state == 'error':\n return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})\n else:\n return ({'changed': True, 'failed': False})\n \n\n def deploy_template(self, poweron=False, wait_for_ip=False):\n\n # https://github.com/vmware/pyvmomi-community-samples/blob/master/samples/clone_vm.py\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.CloneSpec.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.ConfigSpec.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.RelocateSpec.html\n\n # FIXME:\n # - clusters\n # - multiple datacenters\n # - resource pools\n # - multiple templates by the same name\n # - multiple disks\n # - changing the esx host is ignored?\n # - static IPs\n\n # FIXME: need to search for this in the same way as guests to ensure accuracy\n template = get_obj(self.content, [vim.VirtualMachine], self.params['template'])\n if not template:\n self.module.fail_json(msg=\"Could not find a template named %s\" % self.params['template'])\n\n datacenters = get_all_objs(self.content, [vim.Datacenter])\n datacenter = get_obj(self.content, [vim.Datacenter], \n self.params['datacenter'])\n if not datacenter:\n self.module.fail_json(msg='No datacenter named %s was found' % self.params['datacenter'])\n\n if not self.foldermap:\n self.folders, self.foldermap = self.getfolders()\n\n # find matching folders\n if self.params['folder'].startswith('/'):\n folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0] == self.params['folder']]\n else:\n folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0].endswith(self.params['folder'])]\n\n # throw error if more than one match or no matches\n if len(folders) == 0:\n self.module.fail_json(msg='no folder matched the path: %s' % self.params['folder'])\n elif len(folders) > 1:\n self.module.fail_json(msg='too many folders matched \"%s\", please give the full path starting with /vm/' % self.params['folder'])\n\n # grab the folder vim object\n destfolder = folders[0][1]\n\n # if the user wants a cluster, get the list of hosts for the cluster and use the first one\n if self.params['cluster']:\n cluster = get_obj(self.content, [vim.ClusterComputeResource], self.params['cluster'])\n if not cluster:\n self.module.fail_json(msg=\"Failed to find a cluster named %s\" % self.params['cluster'])\n #resource_pool = cluster.resourcePool\n hostsystems = [x for x in cluster.host]\n hostsystem = hostsystems[0]\n else:\n hostsystem = get_obj(self.content, [vim.HostSystem], self.params['esxi_hostname'])\n if not hostsystem:\n self.module.fail_json(msg=\"Failed to find a host named %s\" % self.params['esxi_hostname'])\n\n # set the destination datastore in the relocation spec\n datastore_name = None\n datastore = None\n if self.params['disk']:\n if 'datastore' in self.params['disk'][0]:\n datastore_name = self.params['disk'][0]['datastore']\n datastore = get_obj(self.content, [vim.Datastore], datastore_name)\n if not datastore:\n # use the template's existing DS\n disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]\n datastore = disks[0].backing.datastore\n datastore_name = datastore.name\n if not datastore:\n self.module.fail_json(msg=\"Failed to find a matching datastore\")\n\n # create the relocation spec\n relospec = vim.vm.RelocateSpec()\n relospec.host = hostsystem\n relospec.datastore = datastore\n\n # Find the associated resourcepool for the host system\n # * FIXME: find resourcepool for clusters too\n resource_pool = None\n resource_pools = get_all_objs(self.content, [vim.ResourcePool])\n for rp in resource_pools.items():\n if not rp[0]:\n continue\n if not hasattr(rp[0], 'parent'):\n continue\n if rp[0].parent == hostsystem.parent:\n resource_pool = rp[0] \n break\n if resource_pool:\n relospec.pool = resource_pool\n else:\n self.module.fail_json(msg=\"Failed to find a resource group for %s\" \\\n % hostsystem.name)\n\n clonespec_kwargs = {}\n clonespec_kwargs['location'] = relospec\n\n # create disk spec if not default\n if self.params['disk']:\n # grab the template's first disk and modify it for this customization\n disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]\n diskspec = vim.vm.device.VirtualDeviceSpec()\n # set the operation to edit so that it knows to keep other settings\n diskspec.operation = vim.vm.device.VirtualDeviceSpec.Operation.edit\n diskspec.device = disks[0]\n\n # get the first disk attributes\n pspec = self.params.get('disk')[0]\n\n # is it thin?\n if pspec.get('type', '').lower() == 'thin':\n diskspec.device.backing.thinProvisioned = True\n\n # which datastore?\n if pspec.get('datastore'):\n # This is already handled by the relocation spec,\n # but it needs to eventually be handled for all the\n # other disks defined\n pass\n\n # what size is it?\n if [x for x in pspec.keys() if x.startswith('size_') or x == 'size']:\n # size_tb, size_gb, size_mb, size_kb, size_b ...?\n if 'size' in pspec:\n expected = ''.join(c for c in pspec['size'] if c.isdigit())\n unit = pspec['size'].replace(expected, '').lower()\n expected = int(expected)\n else:\n param = [x for x in pspec.keys() if x.startswith('size_')][0]\n unit = param.split('_')[-1].lower()\n expected = [x[1] for x in pspec.items() if x[0].startswith('size_')][0]\n expected = int(expected)\n\n kb = None\n if unit == 'tb':\n kb = expected * 1024 * 1024 * 1024\n elif unit == 'gb':\n kb = expected * 1024 * 1024\n elif unit ==' mb':\n kb = expected * 1024\n elif unit == 'kb':\n kb = expected\n else:\n self.module.fail_json(msg='%s is not a supported unit for disk size' % unit)\n diskspec.device.capacityInKB = kb\n\n # tell the configspec that the disk device needs to change\n configspec = vim.vm.ConfigSpec(deviceChange=[diskspec])\n clonespec_kwargs['config'] = configspec\n\n # set cpu/memory/etc\n if 'hardware' in self.params:\n if not 'config' in clonespec_kwargs:\n clonespec_kwargs['config'] = vim.vm.ConfigSpec()\n if 'num_cpus' in self.params['hardware']:\n clonespec_kwargs['config'].numCPUs = \\\n int(self.params['hardware']['num_cpus'])\n if 'memory_mb' in self.params['hardware']:\n clonespec_kwargs['config'].memoryMB = \\\n int(self.params['hardware']['memory_mb'])\n\n # lets try and assign a static ip addresss\n if self.params['customize'] is True:\n ip_settings = list()\n if self.params['ips']:\n for ip_string in self.params['ips']:\n ip = IPAddress(self.params['ips'])\n for network in self.params['networks']:\n if network:\n if ip in IPNetwork(network):\n self.params['networks'][network]['ip'] = str(ip)\n ipnet = IPNetwork(network)\n self.params['networks'][network]['subnet_mask'] = str(\n ipnet.netmask\n )\n ip_settings.append(self.params['networks'][network])\n\n key = 0\n network = get_obj(self.content, [vim.Network], ip_settings[key]['network'])\n datacenter = get_obj(self.content, [vim.Datacenter], self.params['datacenter'])\n # get the folder where VMs are kept for this datacenter\n destfolder = datacenter.vmFolder\n\n cluster = get_obj(self.content, [vim.ClusterComputeResource],self.params['cluster'])\n\n devices = []\n adaptermaps = []\n\n try:\n for device in template.config.hardware.device:\n if hasattr(device, 'addressType'):\n nic = vim.vm.device.VirtualDeviceSpec()\n nic.operation = vim.vm.device.VirtualDeviceSpec.Operation.remove\n nic.device = device\n devices.append(nic)\n except:\n pass\n\n # single device support\n nic = vim.vm.device.VirtualDeviceSpec()\n nic.operation = vim.vm.device.VirtualDeviceSpec.Operation.add\n nic.device = vim.vm.device.VirtualVmxnet3()\n nic.device.wakeOnLanEnabled = True\n nic.device.addressType = 'assigned'\n nic.device.deviceInfo = vim.Description()\n nic.device.deviceInfo.label = 'Network Adapter %s' % (key + 1)\n nic.device.deviceInfo.summary = ip_settings[key]['network']\n \n if hasattr(get_obj(self.content, [vim.Network], ip_settings[key]['network']), 'portKeys'):\n # VDS switch\n pg_obj = get_obj(self.content, [vim.dvs.DistributedVirtualPortgroup], ip_settings[key]['network'])\n dvs_port_connection = vim.dvs.PortConnection()\n dvs_port_connection.portgroupKey= pg_obj.key\n dvs_port_connection.switchUuid= pg_obj.config.distributedVirtualSwitch.uuid\n nic.device.backing = vim.vm.device.VirtualEthernetCard.DistributedVirtualPortBackingInfo()\n nic.device.backing.port = dvs_port_connection \n\n else: \n # vSwitch\n nic.device.backing = vim.vm.device.VirtualEthernetCard.NetworkBackingInfo()\n nic.device.backing.network = get_obj(self.content, [vim.Network], ip_settings[key]['network'])\n nic.device.backing.deviceName = ip_settings[key]['network']\n\n nic.device.connectable = vim.vm.device.VirtualDevice.ConnectInfo()\n nic.device.connectable.startConnected = True\n nic.device.connectable.allowGuestControl = True\n nic.device.connectable.connected = True\n nic.device.connectable.allowGuestControl = True\n devices.append(nic)\n \n # Update the spec with the added NIC\n clonespec_kwargs['config'].deviceChange = devices\n\n guest_map = vim.vm.customization.AdapterMapping()\n guest_map.adapter = vim.vm.customization.IPSettings()\n guest_map.adapter.ip = vim.vm.customization.FixedIp()\n guest_map.adapter.ip.ipAddress = str(ip_settings[key]['ip'])\n guest_map.adapter.subnetMask = str(ip_settings[key]['subnet_mask'])\n\n try:\n guest_map.adapter.gateway = ip_settings[key]['gateway']\n except:\n pass\n\n try:\n guest_map.adapter.dnsDomain = self.params['domain']\n except:\n pass\n\n adaptermaps.append(guest_map)\n\n # DNS settings\n globalip = vim.vm.customization.GlobalIPSettings()\n globalip.dnsServerList = self.params['dns_servers']\n globalip.dnsSuffixList = str(self.params['domain'])\n\n # Hostname settings\n ident = vim.vm.customization.LinuxPrep()\n ident.domain = str(self.params['domain'])\n ident.hostName = vim.vm.customization.FixedName()\n ident.hostName.name = self.params['name']\n\n customspec = vim.vm.customization.Specification()\n clonespec_kwargs['customization'] = customspec\n\n clonespec_kwargs['customization'].nicSettingMap = adaptermaps\n clonespec_kwargs['customization'].globalIPSettings = globalip\n clonespec_kwargs['customization'].identity = ident\n\n clonespec = vim.vm.CloneSpec(clonespec_kwargs)\n task = template.Clone(folder=destfolder, name=self.params['name'], spec=clonespec)\n self.wait_for_task(task)\n\n if task.info.state == 'error':\n # https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2021361\n # https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2173\n return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})\n else:\n\n # set annotation\n vm = task.info.result\n if self.params['annotation']:\n annotation_spec = vim.vm.ConfigSpec()\n annotation_spec.annotation = str(self.params['annotation'])\n task = vm.ReconfigVM_Task(annotation_spec)\n self.wait_for_task(task)\n if wait_for_ip:\n self.set_powerstate(vm, 'poweredon', force=False)\n self.wait_for_vm_ip(vm)\n vm_facts = self.gather_facts(vm)\n return ({'changed': True, 'failed': False, 'instance': vm_facts})\n\n def wait_for_task(self, task):\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.Task.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.TaskInfo.html\n # https://github.com/virtdevninja/pyvmomi-community-samples/blob/master/samples/tools/tasks.py\n while task.info.state not in ['success', 'error']:\n time.sleep(1)\n\n def wait_for_vm_ip(self, vm, poll=100, sleep=5): \n ips = None\n facts = {}\n thispoll = 0\n while not ips and thispoll <= poll:\n newvm = self.getvm(uuid=vm.config.uuid)\n facts = self.gather_facts(newvm)\n if facts['ipv4'] or facts['ipv6']:\n ips = True\n else:\n time.sleep(sleep)\n thispoll += 1\n\n return facts\n\n\n def fetch_file_from_guest(self, vm, username, password, src, dest):\n\n ''' Use VMWare's filemanager api to fetch a file over http '''\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/FileManager/FileTransferInformation.rst\n fti = self.content.guestOperationsManager.fileManager. \\\n InitiateFileTransferFromGuest(vm, creds, src)\n\n result['size'] = fti.size\n result['url'] = fti.url\n\n # Use module_utils to fetch the remote url returned from the api\n rsp, info = fetch_url(self.module, fti.url, use_proxy=False, \n force=True, last_mod_time=None, \n timeout=10, headers=None)\n\n # save all of the transfer data\n for k,v in info.iteritems():\n result[k] = v\n\n # exit early if xfer failed\n if info['status'] != 200:\n result['failed'] = True\n return result\n\n # attempt to read the content and write it\n try:\n with open(dest, 'wb') as f:\n f.write(rsp.read()) \n except Exception as e:\n result['failed'] = True\n result['msg'] = str(e)\n\n return result\n\n\n def push_file_to_guest(self, vm, username, password, src, dest, overwrite=True):\n\n ''' Use VMWare's filemanager api to push a file over http '''\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n # the api requires a filesize in bytes\n filesize = None\n fdata = None\n try:\n #filesize = os.path.getsize(src)\n filesize = os.stat(src).st_size\n fdata = None\n with open(src, 'rb') as f:\n fdata = f.read()\n result['local_filesize'] = filesize\n except Exception as e:\n result['failed'] = True\n result['msg'] = \"Unable to read src file: %s\" % str(e)\n return result\n\n # https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.vm.guest.FileManager.html#initiateFileTransferToGuest\n file_attribute = vim.vm.guest.FileManager.FileAttributes()\n url = self.content.guestOperationsManager.fileManager. \\\n InitiateFileTransferToGuest(vm, creds, dest, file_attribute, \n filesize, overwrite)\n\n # PUT the filedata to the url ...\n rsp, info = fetch_url(self.module, url, method=\"put\", data=fdata,\n use_proxy=False, force=True, last_mod_time=None, \n timeout=10, headers=None)\n\n result['msg'] = str(rsp.read())\n\n # save all of the transfer data\n for k,v in info.iteritems():\n result[k] = v\n\n return result\n\n\n def run_command_in_guest(self, vm, username, password, program_path, program_args, program_cwd, program_env):\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n res = None\n pdata = None\n try:\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/ProcessManager.rst\n pm = self.content.guestOperationsManager.processManager\n # https://www.vmware.com/support/developer/converter-sdk/conv51_apireference/vim.vm.guest.ProcessManager.ProgramSpec.html\n ps = vim.vm.guest.ProcessManager.ProgramSpec(\n #programPath=program,\n #arguments=args\n programPath=program_path,\n arguments=program_args,\n workingDirectory=program_cwd,\n )\n res = pm.StartProgramInGuest(vm, creds, ps)\n result['pid'] = res\n pdata = pm.ListProcessesInGuest(vm, creds, [res])\n\n # wait for pid to finish\n while not pdata[0].endTime:\n time.sleep(1)\n pdata = pm.ListProcessesInGuest(vm, creds, [res])\n result['owner'] = pdata[0].owner\n result['startTime'] = pdata[0].startTime.isoformat()\n result['endTime'] = pdata[0].endTime.isoformat()\n result['exitCode'] = pdata[0].exitCode\n if result['exitCode'] != 0:\n result['failed'] = True\n result['msg'] = \"program exited non-zero\"\n else:\n result['msg'] = \"program completed successfully\"\n\n except Exception as e:\n result['msg'] = str(e)\n result['failed'] = True\n\n return result\n\n def list_snapshots_recursively(self, snapshots):\n snapshot_data = []\n snap_text = ''\n for snapshot in snapshots:\n snap_text = 'Id: %s; Name: %s; Description: %s; CreateTime: %s; State: %s'%(snapshot.id, snapshot.name,\n snapshot.description, snapshot.createTime, snapshot.state)\n snapshot_data.append(snap_text)\n snapshot_data = snapshot_data + self.list_snapshots_recursively(snapshot.childSnapshotList)\n return snapshot_data\n\n\n def get_snapshots_by_name_recursively(self, snapshots, snapname):\n snap_obj = []\n for snapshot in snapshots:\n if snapshot.name == snapname:\n snap_obj.append(snapshot)\n else:\n snap_obj = snap_obj + self.get_snapshots_by_name_recursively(snapshot.childSnapshotList, snapname)\n return snap_obj\n\n def get_current_snap_obj(self, snapshots, snapob):\n snap_obj = []\n for snapshot in snapshots:\n if snapshot.snapshot == snapob:\n snap_obj.append(snapshot)\n snap_obj = snap_obj + self.get_current_snap_obj(snapshot.childSnapshotList, snapob)\n return snap_obj\n\n def snapshot_vm(self, vm, guest, snapshot_op):\n ''' To perform snapshot operations create/remove/revert/list_all/list_current/remove_all '''\n\n try:\n snapshot_op_name = snapshot_op['op_type']\n except KeyError:\n self.module.fail_json(msg=\"Specify op_type - create/remove/revert/list_all/list_current/remove_all\")\n\n task = None\n result = {}\n\n if snapshot_op_name not in ['create', 'remove', 'revert', 'list_all', 'list_current', 'remove_all']:\n self.module.fail_json(msg=\"Specify op_type - create/remove/revert/list_all/list_current/remove_all\")\n\n if snapshot_op_name != 'create' and vm.snapshot is None:\n self.module.exit_json(msg=\"VM - %s doesn't have any snapshots\"%guest)\n\n if snapshot_op_name == 'create':\n try:\n snapname = snapshot_op['name']\n except KeyError:\n self.module.fail_json(msg=\"specify name & description(optional) to create a snapshot\")\n\n if 'description' in snapshot_op:\n snapdesc = snapshot_op['description']\n else:\n snapdesc = ''\n\n dumpMemory = False\n quiesce = False\n task = vm.CreateSnapshot(snapname, snapdesc, dumpMemory, quiesce)\n\n elif snapshot_op_name in ['remove', 'revert']:\n try:\n snapname = snapshot_op['name']\n except KeyError:\n self.module.fail_json(msg=\"specify snapshot name\")\n\n snap_obj = self.get_snapshots_by_name_recursively(vm.snapshot.rootSnapshotList, snapname)\n\n #if len(snap_obj) is 0; then no snapshots with specified name\n if len(snap_obj) == 1:\n snap_obj = snap_obj[0].snapshot\n if snapshot_op_name == 'remove':\n task = snap_obj.RemoveSnapshot_Task(True)\n else:\n task = snap_obj.RevertToSnapshot_Task()\n else:\n self.module.exit_json(msg=\"Couldn't find any snapshots with specified name: %s on VM: %s\"%(snapname, guest))\n\n elif snapshot_op_name == 'list_all':\n snapshot_data = self.list_snapshots_recursively(vm.snapshot.rootSnapshotList)\n result['snapshot_data'] = snapshot_data\n\n elif snapshot_op_name == 'list_current':\n current_snapref = vm.snapshot.currentSnapshot\n current_snap_obj = self.get_current_snap_obj(vm.snapshot.rootSnapshotList, current_snapref)\n result['current_snapshot'] = 'Id: %s; Name: %s; Description: %s; CreateTime: %s; State: %s'%(current_snap_obj[0].id,\n current_snap_obj[0].name, current_snap_obj[0].description, current_snap_obj[0].createTime,\n current_snap_obj[0].state)\n\n elif snapshot_op_name == 'remove_all':\n task = vm.RemoveAllSnapshots()\n\n if task:\n self.wait_for_task(task)\n if task.info.state == 'error':\n result = {'changed': False, 'failed': True, 'msg': task.info.error.msg}\n else:\n result = {'changed': True, 'failed': False}\n\n return result\n\ndef get_obj(content, vimtype, name):\n \"\"\"\n Return an object by name, if name is None the\n first found object is returned\n \"\"\"\n obj = None\n container = content.viewManager.CreateContainerView(\n content.rootFolder, vimtype, True)\n for c in container.view:\n if name:\n if c.name == name:\n obj = c\n break\n else:\n obj = c\n break\n\n container.Destroy()\n return obj\n\n\ndef main():\n\n vm = None\n\n module = AnsibleModule(\n argument_spec=dict(\n hostname=dict(\n type='str',\n default=os.environ.get('VMWARE_HOST')\n ),\n username=dict(\n type='str',\n default=os.environ.get('VMWARE_USER')\n ),\n password=dict(\n type='str', no_log=True,\n default=os.environ.get('VMWARE_PASSWORD')\n ),\n state=dict(\n required=False,\n choices=[\n 'poweredon',\n 'poweredoff',\n 'present',\n 'absent',\n 'restarted',\n 'reconfigured'\n ],\n default='present'),\n validate_certs=dict(required=False, type='bool', default=True),\n template_src=dict(required=False, type='str', aliases=['template']),\n annotation=dict(required=False, type='str', aliases=['notes']),\n name=dict(required=True, type='str'),\n name_match=dict(required=False, type='str', default='first'),\n snapshot_op=dict(required=False, type='dict', default={}),\n uuid=dict(required=False, type='str'),\n folder=dict(required=False, type='str', default='/vm', aliases=['folder']),\n disk=dict(required=False, type='list'),\n nic=dict(required=False, type='list'),\n hardware=dict(required=False, type='dict', default={}),\n force=dict(required=False, type='bool', default=False),\n datacenter=dict(required=False, type='str', default=None),\n esxi_hostname=dict(required=False, type='str', default=None),\n cluster=dict(required=False, type='str', default=None),\n wait_for_ip_address=dict(required=False, type='bool', default=True),\n customize=dict(required=False, type='bool', default=False),\n ips=dict(required=False, type='str', default=None),\n dns_servers=dict(required=False, type='list', default=None),\n domain=dict(required=False, type='str', default=None),\n networks=dict(required=False, type='dict', default={})\n ),\n supports_check_mode=True,\n mutually_exclusive=[],\n required_together=[\n ['state', 'force'],\n ['template'],\n ],\n )\n\n pyv = PyVmomiHelper(module)\n\n # Check if the VM exists before continuing\n vm = pyv.getvm(name=module.params['name'], \n folder=module.params['folder'], \n uuid=module.params['uuid'], \n name_match=module.params['name_match'])\n\n # VM already exists\n if vm:\n\n if module.params['state'] == 'absent':\n # destroy it\n if module.params['force']:\n # has to be poweredoff first\n result = pyv.set_powerstate(vm, 'poweredoff', module.params['force'])\n result = pyv.remove_vm(vm)\n elif module.params['state'] in ['poweredon', 'poweredoff', 'restarted']:\n # set powerstate\n result = pyv.set_powerstate(vm, module.params['state'], module.params['force'])\n elif module.params['snapshot_op']:\n result = pyv.snapshot_vm(vm, module.params['name'], module.params['snapshot_op'])\n else:\n # Run for facts only\n try:\n module.exit_json(instance=pyv.gather_facts(vm))\n except Exception:\n e = get_exception()\n module.fail_json(\n msg=\"Fact gather failed with exception %s\" % e)\n\n # VM doesn't exist\n else:\n create_states = ['poweredon', 'poweredoff', 'present', 'restarted']\n if module.params['state'] in create_states:\n poweron = (module.params['state'] != 'poweredoff')\n # Create it ...\n result = pyv.deploy_template(\n poweron=poweron, \n wait_for_ip=module.params['wait_for_ip_address']\n )\n result['changed'] = True\n elif module.params['state'] == 'absent':\n result = {'changed': False, 'failed': False}\n else:\n result = {'changed': False, 'failed': False}\n\n # FIXME\n if not 'failed' in result:\n result['failed'] = False\n\n if result['failed']:\n module.fail_json(result)\n else:\n module.exit_json(*result)\n\n\nfrom ansible.module_utils.vmware import \nfrom ansible.module_utils.basic import *\n\nif __name__ == '__main__':\n main()\n", "path": "cloud/vmware/vmware_guest.py" } ]	[ { "content": "#!/usr/bin/python\n# -- coding: utf-8 --\n# This file is part of Ansible\n#\n# Ansible is free software: you can redistribute it and/or modify\n# it under the terms of the GNU General Public License as published by\n# the Free Software Foundation, either version 3 of the License, or\n# (at your option) any later version.\n#\n# Ansible is distributed in the hope that it will be useful,\n# but WITHOUT ANY WARRANTY; without even the implied warranty of\n# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n# GNU General Public License for more details.\n#\n# You should have received a copy of the GNU General Public License\n# along with Ansible. If not, see <http://www.gnu.org/licenses/>.\n\nDOCUMENTATION = '''\n---\nmodule: vmware_guest\nshort_description: Manages virtualmachines in vcenter\ndescription:\n - Uses pyvmomi to ...\n - copy a template to a new virtualmachine\n - poweron/poweroff/restart a virtualmachine\n - remove a virtualmachine\nversion_added: 2.2\nauthor: James Tanner (@jctanner) <[email protected]>\nnotes:\n - Tested on vSphere 6.0\nrequirements:\n - \"python >= 2.6\"\n - PyVmomi\noptions:\n state:\n description:\n - What state should the virtualmachine be in?\n required: True\n choices: ['present', 'absent', 'poweredon', 'poweredoff', 'restarted', 'suspended']\n name:\n description:\n - Name of the newly deployed guest\n required: True\n name_match:\n description:\n - If multiple vms matching the name, use the first or last found \n required: False\n default: 'first'\n choices: ['first', 'last']\n uuid:\n description:\n - UUID of the instance to manage if known, this is vmware's unique identifier.\n - This is required if name is not supplied.\n required: False\n template:\n description:\n - Name of the template to deploy, if needed to create the guest (state=present).\n - If the guest exists already this setting will be ignored.\n required: False\n folder:\n description:\n - Destination folder path for the new guest\n required: False\n hardware:\n description:\n - Attributes such as cpus, memory, osid, and disk controller\n required: False\n disk:\n description:\n - A list of disks to add\n required: False\n nic:\n description:\n - A list of nics to add\n required: False\n wait_for_ip_address:\n description:\n - Wait until vcenter detects an IP address for the guest\n required: False\n force:\n description:\n - Ignore warnings and complete the actions\n required: False\n datacenter:\n description:\n - Destination datacenter for the deploy operation\n required: True\n esxi_hostname:\n description:\n - The esxi hostname where the VM will run.\n required: False\n annotation:\n description:\n - A note or annotation to include in the VM\n required: False\n version_added: \"2.3\"\n customize:\n description:\n - Should customization spec be run\n required: False\n version_added: \"2.3\"\n ips:\n description:\n - IP Addresses to set\n required: False\n version_added: \"2.3\"\n networks: \n description:\n - Network to use should include VM network name and gateway\n required: False\n version_added: \"2.3\"\n dns_servers:\n description:\n - DNS servers to use\n required: False\n version_added: \"2.3\"\n domain: \n description:\n - Domain to use while customizing\n required: False\n version_added: \"2.3\"\n snapshot_op:\n description:\n - A key, value pair of snapshot operation types and their additional required parameters.\n required: False\n version_added: \"2.3\"\nextends_documentation_fragment: vmware.documentation \n'''\n\nEXAMPLES = '''\nExample from Ansible playbook\n#\n# Create a VM from a template\n#\n - name: create the VM\n vmware_guest:\n validate_certs: False\n hostname: 192.0.2.44\n username: [email protected]\n password: vmware\n name: testvm_2\n state: poweredon\n folder: testvms\n disk:\n - size_gb: 10\n type: thin\n datastore: g73_datastore\n nic:\n - type: vmxnet3\n network: VM Network\n network_type: standard\n hardware:\n memory_mb: 512\n num_cpus: 1\n osid: centos64guest\n scsi: paravirtual\n datacenter: datacenter1\n esxi_hostname: 192.0.2.117\n template: template_el7\n wait_for_ip_address: yes\n register: deploy\n\n#\n# Clone Template and customize\n#\n - name: Clone template and customize\n vmware_guest:\n hostname: \"192.168.1.209\"\n username: \"[email protected]\"\n password: \"vmware\"\n validate_certs: False\n name: testvm-2\n datacenter: datacenter1\n cluster: cluster\n validate_certs: False\n template: template_el7\n customize: True\n domain: \"example.com\"\n dns_servers: ['192.168.1.1','192.168.1.2']\n ips: \"192.168.1.100\"\n networks:\n '192.168.1.0/24':\n network: 'VM Network'\n gateway: '192.168.1.1' \n#\n# Gather facts only\n#\n - name: gather the VM facts\n vmware_guest:\n validate_certs: False\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n name: testvm_2\n esxi_hostname: 192.168.1.117\n register: facts\n\n### Snapshot Operations\n# Create snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: create\n name: snap1\n description: snap1_description\n\n# Remove a snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: remove\n name: snap1\n\n# Revert to a snapshot\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: revert\n name: snap1\n\n# List all snapshots of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: list_all\n\n# List current snapshot of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: list_current\n\n# Remove all snapshots of a VM\n - vmware_guest:\n hostname: 192.168.1.209\n username: [email protected]\n password: vmware\n validate_certs: False\n name: dummy_vm\n snapshot_op:\n op_type: remove_all\n'''\n\nRETURN = \"\"\"\ninstance:\n descripton: metadata about the new virtualmachine\n returned: always\n type: dict\n sample: None\n\"\"\"\n\ntry:\n import json\nexcept ImportError:\n import simplejson as json\n\nHAS_PYVMOMI = False\ntry:\n import pyVmomi\n from pyVmomi import vim\n HAS_PYVMOMI = True\nexcept ImportError:\n pass\n\nimport os\nimport time\nfrom netaddr import IPNetwork, IPAddress\n\nfrom ansible.module_utils.urls import fetch_url\n\nclass PyVmomiHelper(object):\n\n def __init__(self, module):\n\n if not HAS_PYVMOMI:\n module.fail_json(msg='pyvmomi module required')\n\n self.module = module\n self.params = module.params\n self.si = None\n self.smartconnect()\n self.datacenter = None\n self.folders = None\n self.foldermap = None\n\n def smartconnect(self):\n self.content = connect_to_api(self.module)\n\n def _build_folder_tree(self, folder, tree={}, treepath=None):\n\n tree = {'virtualmachines': [],\n 'subfolders': {},\n 'vimobj': folder,\n 'name': folder.name}\n\n children = None\n if hasattr(folder, 'childEntity'):\n children = folder.childEntity\n\n if children:\n for child in children:\n if child == folder or child in tree:\n continue\n if isinstance(child, vim.Folder):\n ctree = self._build_folder_tree(child)\n tree['subfolders'][child] = dict.copy(ctree)\n elif isinstance(child, vim.VirtualMachine):\n tree['virtualmachines'].append(child)\n else:\n if isinstance(folder, vim.VirtualMachine):\n return folder\n return tree\n\n\n def _build_folder_map(self, folder, vmap={}, inpath='/'):\n\n ''' Build a searchable index for vms+uuids+folders '''\n\n if isinstance(folder, tuple):\n folder = folder[1]\n\n if not 'names' in vmap:\n vmap['names'] = {}\n if not 'uuids' in vmap:\n vmap['uuids'] = {}\n if not 'paths' in vmap:\n vmap['paths'] = {}\n\n if inpath == '/':\n thispath = '/vm'\n else:\n thispath = os.path.join(inpath, folder['name'])\n\n if thispath not in vmap['paths']:\n vmap['paths'][thispath] = []\n\n # helpful for isolating folder objects later on\n if not 'path_by_fvim' in vmap:\n vmap['path_by_fvim'] = {}\n if not 'fvim_by_path' in vmap:\n vmap['fvim_by_path'] = {}\n # store object by path and store path by object\n vmap['fvim_by_path'][thispath] = folder['vimobj']\n vmap['path_by_fvim'][folder['vimobj']] = thispath\n\n # helpful for isolating vm objects later on\n if not 'path_by_vvim' in vmap:\n vmap['path_by_vvim'] = {}\n if not 'vvim_by_path' in vmap:\n vmap['vvim_by_path'] = {}\n if thispath not in vmap['vvim_by_path']:\n vmap['vvim_by_path'][thispath] = []\n \n\n for item in folder.items():\n k = item[0]\n v = item[1]\n\n if k == 'name':\n pass\n elif k == 'subfolders':\n for x in v.items():\n vmap = self._build_folder_map(x, vmap=vmap, inpath=thispath)\n elif k == 'virtualmachines':\n for x in v:\n if not x.config.name in vmap['names']:\n vmap['names'][x.config.name] = []\n vmap['names'][x.config.name].append(x.config.uuid)\n vmap['uuids'][x.config.uuid] = x.config.name\n vmap['paths'][thispath].append(x.config.uuid)\n\n if x not in vmap['vvim_by_path'][thispath]:\n vmap['vvim_by_path'][thispath].append(x)\n if x not in vmap['path_by_vvim']:\n vmap['path_by_vvim'][x] = thispath\n return vmap\n\n def getfolders(self):\n\n if not self.datacenter:\n self.get_datacenter()\n self.folders = self._build_folder_tree(self.datacenter.vmFolder)\n self.folder_map = self._build_folder_map(self.folders)\n return (self.folders, self.folder_map)\n\n def compile_folder_path_for_object(self, vobj):\n ''' make a /vm/foo/bar/baz like folder path for an object '''\n paths = []\n if isinstance(vobj, vim.Folder):\n paths.append(vobj.name)\n\n thisobj = vobj\n while hasattr(thisobj, 'parent'):\n thisobj = thisobj.parent\n if isinstance(thisobj, vim.Folder):\n paths.append(thisobj.name)\n paths.reverse()\n if paths[0] == 'Datacenters':\n paths.remove('Datacenters')\n return '/' + '/'.join(paths)\n\n def get_datacenter(self):\n self.datacenter = get_obj(self.content, [vim.Datacenter], \n self.params['datacenter'])\n\n def getvm(self, name=None, uuid=None, folder=None, name_match=None):\n\n # https://www.vmware.com/support/developer/vc-sdk/visdk2xpubs/ReferenceGuide/vim.SearchIndex.html\n # self.si.content.searchIndex.FindByInventoryPath('DC1/vm/test_folder')\n\n vm = None\n folder_path = None\n searchpath = None\n\n if uuid:\n vm = self.content.searchIndex.FindByUuid(uuid=uuid, vmSearch=True)\n\n elif folder:\n\n if self.params['folder'].endswith('/'):\n self.params['folder'] = self.params['folder'][0:-1]\n\n # Build the absolute folder path to pass into the search method\n if self.params['folder'].startswith('/vm'):\n searchpath = '%s' % self.params['datacenter']\n searchpath += self.params['folder']\n elif self.params['folder'].startswith('/'):\n searchpath = '%s' % self.params['datacenter']\n searchpath += '/vm' + self.params['folder']\n else:\n # need to look for matching absolute path\n if not self.folders:\n self.getfolders()\n paths = self.folder_map['paths'].keys()\n paths = [x for x in paths if x.endswith(self.params['folder'])]\n if len(paths) > 1:\n self.module.fail_json(msg='%s matches more than one folder. Please use the absolute path starting with /vm/' % self.params['folder'])\n elif paths:\n searchpath = paths[0]\n\n if searchpath:\n # get all objects for this path ...\n fObj = self.content.searchIndex.FindByInventoryPath(searchpath)\n if fObj:\n if isinstance(fObj, vim.Datacenter):\n fObj = fObj.vmFolder\n for cObj in fObj.childEntity:\n if not isinstance(cObj, vim.VirtualMachine):\n continue\n if cObj.name == name:\n vm = cObj\n break\n\n if not vm:\n\n # FIXME - this is unused if folder has a default value\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n\n # narrow down by folder\n if folder:\n if not self.folders:\n self.getfolders()\n\n # compare the folder path of each VM against the search path\n for item in vmList.items():\n vobj = item[0]\n if not isinstance(vobj.parent, vim.Folder):\n continue\n if self.compile_folder_path_for_object(vobj) == searchpath:\n return vobj\n\n if name_match:\n if name_match == 'first':\n vm = get_obj(self.content, [vim.VirtualMachine], name)\n elif name_match == 'last':\n matches = []\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n for thisvm in vmList:\n if thisvm.config.name == name:\n matches.append(thisvm)\n if matches:\n vm = matches[-1]\n else: \n matches = []\n vmList = get_all_objs(self.content, [vim.VirtualMachine])\n for thisvm in vmList:\n if thisvm.config.name == name:\n matches.append(thisvm)\n if len(matches) > 1:\n module.fail_json(msg='more than 1 vm exists by the name %s. Please specify a uuid, or a folder, or a datacenter or name_match' % name)\n if matches:\n vm = matches[0]\n\n return vm\n\n\n def set_powerstate(self, vm, state, force):\n \"\"\"\n Set the power status for a VM determined by the current and\n requested states. force is forceful\n \"\"\"\n facts = self.gather_facts(vm)\n expected_state = state.replace('_', '').lower()\n current_state = facts['hw_power_status'].lower()\n result = {}\n\n # Need Force\n if not force and current_state not in ['poweredon', 'poweredoff']:\n return \"VM is in %s power state. Force is required!\" % current_state\n\n # State is already true\n if current_state == expected_state:\n result['changed'] = False\n result['failed'] = False\n else:\n task = None\n try:\n if expected_state == 'poweredoff':\n task = vm.PowerOff()\n\n elif expected_state == 'poweredon':\n task = vm.PowerOn()\n\n elif expected_state == 'restarted':\n if current_state in ('poweredon', 'poweringon', 'resetting'):\n task = vm.Reset()\n else:\n result = {'changed': False, 'failed': True, \n 'msg': \"Cannot restart VM in the current state %s\" % current_state}\n\n except Exception:\n result = {'changed': False, 'failed': True, \n 'msg': get_exception()}\n\n if task:\n self.wait_for_task(task)\n if task.info.state == 'error':\n result = {'changed': False, 'failed': True, 'msg': task.info.error.msg}\n else:\n result = {'changed': True, 'failed': False}\n\n # need to get new metadata if changed\n if result['changed']:\n newvm = self.getvm(uuid=vm.config.uuid)\n facts = self.gather_facts(newvm)\n result['instance'] = facts\n return result\n\n\n def gather_facts(self, vm):\n\n ''' Gather facts from vim.VirtualMachine object. '''\n\n facts = {\n 'module_hw': True,\n 'hw_name': vm.config.name,\n 'hw_power_status': vm.summary.runtime.powerState,\n 'hw_guest_full_name': vm.summary.guest.guestFullName,\n 'hw_guest_id': vm.summary.guest.guestId,\n 'hw_product_uuid': vm.config.uuid,\n 'hw_processor_count': vm.config.hardware.numCPU,\n 'hw_memtotal_mb': vm.config.hardware.memoryMB,\n 'hw_interfaces':[],\n 'ipv4': None,\n 'ipv6': None,\n }\n\n netDict = {}\n for device in vm.guest.net:\n mac = device.macAddress\n ips = list(device.ipAddress)\n netDict[mac] = ips\n for k,v in netDict.iteritems():\n for ipaddress in v:\n if ipaddress:\n if '::' in ipaddress:\n facts['ipv6'] = ipaddress\n else:\n facts['ipv4'] = ipaddress\n\n for idx,entry in enumerate(vm.config.hardware.device):\n if not hasattr(entry, 'macAddress'):\n continue\n\n factname = 'hw_eth' + str(idx)\n facts[factname] = {\n 'addresstype': entry.addressType,\n 'label': entry.deviceInfo.label,\n 'macaddress': entry.macAddress,\n 'ipaddresses': netDict.get(entry.macAddress, None),\n 'macaddress_dash': entry.macAddress.replace(':', '-'),\n 'summary': entry.deviceInfo.summary,\n }\n facts['hw_interfaces'].append('eth'+str(idx))\n\n return facts\n\n\n def remove_vm(self, vm):\n # https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.ManagedEntity.html#destroy\n task = vm.Destroy()\n self.wait_for_task(task)\n\n if task.info.state == 'error':\n return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})\n else:\n return ({'changed': True, 'failed': False})\n \n\n def deploy_template(self, poweron=False, wait_for_ip=False):\n\n # https://github.com/vmware/pyvmomi-community-samples/blob/master/samples/clone_vm.py\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.CloneSpec.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.vm.ConfigSpec.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk41pubs/ApiReference/vim.vm.RelocateSpec.html\n\n # FIXME:\n # - clusters\n # - multiple datacenters\n # - resource pools\n # - multiple templates by the same name\n # - multiple disks\n # - changing the esx host is ignored?\n # - static IPs\n\n # FIXME: need to search for this in the same way as guests to ensure accuracy\n template = get_obj(self.content, [vim.VirtualMachine], self.params['template'])\n if not template:\n self.module.fail_json(msg=\"Could not find a template named %s\" % self.params['template'])\n\n datacenters = get_all_objs(self.content, [vim.Datacenter])\n datacenter = get_obj(self.content, [vim.Datacenter], \n self.params['datacenter'])\n if not datacenter:\n self.module.fail_json(msg='No datacenter named %s was found' % self.params['datacenter'])\n\n if not self.foldermap:\n self.folders, self.foldermap = self.getfolders()\n\n # find matching folders\n if self.params['folder'].startswith('/'):\n folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0] == self.params['folder']]\n else:\n folders = [x for x in self.foldermap['fvim_by_path'].items() if x[0].endswith(self.params['folder'])]\n\n # throw error if more than one match or no matches\n if len(folders) == 0:\n self.module.fail_json(msg='no folder matched the path: %s' % self.params['folder'])\n elif len(folders) > 1:\n self.module.fail_json(msg='too many folders matched \"%s\", please give the full path starting with /vm/' % self.params['folder'])\n\n # grab the folder vim object\n destfolder = folders[0][1]\n\n # if the user wants a cluster, get the list of hosts for the cluster and use the first one\n if self.params['cluster']:\n cluster = get_obj(self.content, [vim.ClusterComputeResource], self.params['cluster'])\n if not cluster:\n self.module.fail_json(msg=\"Failed to find a cluster named %s\" % self.params['cluster'])\n #resource_pool = cluster.resourcePool\n hostsystems = [x for x in cluster.host]\n hostsystem = hostsystems[0]\n else:\n hostsystem = get_obj(self.content, [vim.HostSystem], self.params['esxi_hostname'])\n if not hostsystem:\n self.module.fail_json(msg=\"Failed to find a host named %s\" % self.params['esxi_hostname'])\n\n # set the destination datastore in the relocation spec\n datastore_name = None\n datastore = None\n if self.params['disk']:\n if 'datastore' in self.params['disk'][0]:\n datastore_name = self.params['disk'][0]['datastore']\n datastore = get_obj(self.content, [vim.Datastore], datastore_name)\n if not datastore:\n # use the template's existing DS\n disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]\n datastore = disks[0].backing.datastore\n datastore_name = datastore.name\n if not datastore:\n self.module.fail_json(msg=\"Failed to find a matching datastore\")\n\n # create the relocation spec\n relospec = vim.vm.RelocateSpec()\n relospec.host = hostsystem\n relospec.datastore = datastore\n\n # Find the associated resourcepool for the host system\n # * FIXME: find resourcepool for clusters too\n resource_pool = None\n resource_pools = get_all_objs(self.content, [vim.ResourcePool])\n for rp in resource_pools.items():\n if not rp[0]:\n continue\n if not hasattr(rp[0], 'parent'):\n continue\n if rp[0].parent == hostsystem.parent:\n resource_pool = rp[0] \n break\n if resource_pool:\n relospec.pool = resource_pool\n else:\n self.module.fail_json(msg=\"Failed to find a resource group for %s\" \\\n % hostsystem.name)\n\n clonespec_kwargs = {}\n clonespec_kwargs['location'] = relospec\n\n # create disk spec if not default\n if self.params['disk']:\n # grab the template's first disk and modify it for this customization\n disks = [x for x in template.config.hardware.device if isinstance(x, vim.vm.device.VirtualDisk)]\n diskspec = vim.vm.device.VirtualDeviceSpec()\n # set the operation to edit so that it knows to keep other settings\n diskspec.operation = vim.vm.device.VirtualDeviceSpec.Operation.edit\n diskspec.device = disks[0]\n\n # get the first disk attributes\n pspec = self.params.get('disk')[0]\n\n # is it thin?\n if pspec.get('type', '').lower() == 'thin':\n diskspec.device.backing.thinProvisioned = True\n\n # which datastore?\n if pspec.get('datastore'):\n # This is already handled by the relocation spec,\n # but it needs to eventually be handled for all the\n # other disks defined\n pass\n\n # what size is it?\n if [x for x in pspec.keys() if x.startswith('size_') or x == 'size']:\n # size_tb, size_gb, size_mb, size_kb, size_b ...?\n if 'size' in pspec:\n expected = ''.join(c for c in pspec['size'] if c.isdigit())\n unit = pspec['size'].replace(expected, '').lower()\n expected = int(expected)\n else:\n param = [x for x in pspec.keys() if x.startswith('size_')][0]\n unit = param.split('_')[-1].lower()\n expected = [x[1] for x in pspec.items() if x[0].startswith('size_')][0]\n expected = int(expected)\n\n kb = None\n if unit == 'tb':\n kb = expected * 1024 * 1024 * 1024\n elif unit == 'gb':\n kb = expected * 1024 * 1024\n elif unit ==' mb':\n kb = expected * 1024\n elif unit == 'kb':\n kb = expected\n else:\n self.module.fail_json(msg='%s is not a supported unit for disk size' % unit)\n diskspec.device.capacityInKB = kb\n\n # tell the configspec that the disk device needs to change\n configspec = vim.vm.ConfigSpec(deviceChange=[diskspec])\n clonespec_kwargs['config'] = configspec\n\n # set cpu/memory/etc\n if 'hardware' in self.params:\n if not 'config' in clonespec_kwargs:\n clonespec_kwargs['config'] = vim.vm.ConfigSpec()\n if 'num_cpus' in self.params['hardware']:\n clonespec_kwargs['config'].numCPUs = \\\n int(self.params['hardware']['num_cpus'])\n if 'memory_mb' in self.params['hardware']:\n clonespec_kwargs['config'].memoryMB = \\\n int(self.params['hardware']['memory_mb'])\n\n # lets try and assign a static ip addresss\n if self.params['customize'] is True:\n ip_settings = list()\n if self.params['ips']:\n for ip_string in self.params['ips']:\n ip = IPAddress(self.params['ips'])\n for network in self.params['networks']:\n if network:\n if ip in IPNetwork(network):\n self.params['networks'][network]['ip'] = str(ip)\n ipnet = IPNetwork(network)\n self.params['networks'][network]['subnet_mask'] = str(\n ipnet.netmask\n )\n ip_settings.append(self.params['networks'][network])\n\n key = 0\n network = get_obj(self.content, [vim.Network], ip_settings[key]['network'])\n datacenter = get_obj(self.content, [vim.Datacenter], self.params['datacenter'])\n # get the folder where VMs are kept for this datacenter\n destfolder = datacenter.vmFolder\n\n cluster = get_obj(self.content, [vim.ClusterComputeResource],self.params['cluster'])\n\n devices = []\n adaptermaps = []\n\n try:\n for device in template.config.hardware.device:\n if hasattr(device, 'addressType'):\n nic = vim.vm.device.VirtualDeviceSpec()\n nic.operation = vim.vm.device.VirtualDeviceSpec.Operation.remove\n nic.device = device\n devices.append(nic)\n except:\n pass\n\n # single device support\n nic = vim.vm.device.VirtualDeviceSpec()\n nic.operation = vim.vm.device.VirtualDeviceSpec.Operation.add\n nic.device = vim.vm.device.VirtualVmxnet3()\n nic.device.wakeOnLanEnabled = True\n nic.device.addressType = 'assigned'\n nic.device.deviceInfo = vim.Description()\n nic.device.deviceInfo.label = 'Network Adapter %s' % (key + 1)\n nic.device.deviceInfo.summary = ip_settings[key]['network']\n \n if hasattr(get_obj(self.content, [vim.Network], ip_settings[key]['network']), 'portKeys'):\n # VDS switch\n pg_obj = get_obj(self.content, [vim.dvs.DistributedVirtualPortgroup], ip_settings[key]['network'])\n dvs_port_connection = vim.dvs.PortConnection()\n dvs_port_connection.portgroupKey= pg_obj.key\n dvs_port_connection.switchUuid= pg_obj.config.distributedVirtualSwitch.uuid\n nic.device.backing = vim.vm.device.VirtualEthernetCard.DistributedVirtualPortBackingInfo()\n nic.device.backing.port = dvs_port_connection \n\n else: \n # vSwitch\n nic.device.backing = vim.vm.device.VirtualEthernetCard.NetworkBackingInfo()\n nic.device.backing.network = get_obj(self.content, [vim.Network], ip_settings[key]['network'])\n nic.device.backing.deviceName = ip_settings[key]['network']\n\n nic.device.connectable = vim.vm.device.VirtualDevice.ConnectInfo()\n nic.device.connectable.startConnected = True\n nic.device.connectable.allowGuestControl = True\n nic.device.connectable.connected = True\n nic.device.connectable.allowGuestControl = True\n devices.append(nic)\n \n # Update the spec with the added NIC\n clonespec_kwargs['config'].deviceChange = devices\n\n guest_map = vim.vm.customization.AdapterMapping()\n guest_map.adapter = vim.vm.customization.IPSettings()\n guest_map.adapter.ip = vim.vm.customization.FixedIp()\n guest_map.adapter.ip.ipAddress = str(ip_settings[key]['ip'])\n guest_map.adapter.subnetMask = str(ip_settings[key]['subnet_mask'])\n\n try:\n guest_map.adapter.gateway = ip_settings[key]['gateway']\n except:\n pass\n\n try:\n guest_map.adapter.dnsDomain = self.params['domain']\n except:\n pass\n\n adaptermaps.append(guest_map)\n\n # DNS settings\n globalip = vim.vm.customization.GlobalIPSettings()\n globalip.dnsServerList = self.params['dns_servers']\n globalip.dnsSuffixList = str(self.params['domain'])\n\n # Hostname settings\n ident = vim.vm.customization.LinuxPrep()\n ident.domain = str(self.params['domain'])\n ident.hostName = vim.vm.customization.FixedName()\n ident.hostName.name = self.params['name']\n\n customspec = vim.vm.customization.Specification()\n clonespec_kwargs['customization'] = customspec\n\n clonespec_kwargs['customization'].nicSettingMap = adaptermaps\n clonespec_kwargs['customization'].globalIPSettings = globalip\n clonespec_kwargs['customization'].identity = ident\n\n clonespec = vim.vm.CloneSpec(clonespec_kwargs)\n task = template.Clone(folder=destfolder, name=self.params['name'], spec=clonespec)\n self.wait_for_task(task)\n\n if task.info.state == 'error':\n # https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2021361\n # https://kb.vmware.com/selfservice/microsites/search.do?language=en_US&cmd=displayKC&externalId=2173\n return ({'changed': False, 'failed': True, 'msg': task.info.error.msg})\n else:\n\n # set annotation\n vm = task.info.result\n if self.params['annotation']:\n annotation_spec = vim.vm.ConfigSpec()\n annotation_spec.annotation = str(self.params['annotation'])\n task = vm.ReconfigVM_Task(annotation_spec)\n self.wait_for_task(task)\n if wait_for_ip:\n self.set_powerstate(vm, 'poweredon', force=False)\n self.wait_for_vm_ip(vm)\n vm_facts = self.gather_facts(vm)\n return ({'changed': True, 'failed': False, 'instance': vm_facts})\n\n def wait_for_task(self, task):\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.Task.html\n # https://www.vmware.com/support/developer/vc-sdk/visdk25pubs/ReferenceGuide/vim.TaskInfo.html\n # https://github.com/virtdevninja/pyvmomi-community-samples/blob/master/samples/tools/tasks.py\n while task.info.state not in ['success', 'error']:\n time.sleep(1)\n\n def wait_for_vm_ip(self, vm, poll=100, sleep=5): \n ips = None\n facts = {}\n thispoll = 0\n while not ips and thispoll <= poll:\n newvm = self.getvm(uuid=vm.config.uuid)\n facts = self.gather_facts(newvm)\n if facts['ipv4'] or facts['ipv6']:\n ips = True\n else:\n time.sleep(sleep)\n thispoll += 1\n\n return facts\n\n\n def fetch_file_from_guest(self, vm, username, password, src, dest):\n\n ''' Use VMWare's filemanager api to fetch a file over http '''\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/FileManager/FileTransferInformation.rst\n fti = self.content.guestOperationsManager.fileManager. \\\n InitiateFileTransferFromGuest(vm, creds, src)\n\n result['size'] = fti.size\n result['url'] = fti.url\n\n # Use module_utils to fetch the remote url returned from the api\n rsp, info = fetch_url(self.module, fti.url, use_proxy=False, \n force=True, last_mod_time=None, \n timeout=10, headers=None)\n\n # save all of the transfer data\n for k,v in info.iteritems():\n result[k] = v\n\n # exit early if xfer failed\n if info['status'] != 200:\n result['failed'] = True\n return result\n\n # attempt to read the content and write it\n try:\n with open(dest, 'wb') as f:\n f.write(rsp.read()) \n except Exception as e:\n result['failed'] = True\n result['msg'] = str(e)\n\n return result\n\n\n def push_file_to_guest(self, vm, username, password, src, dest, overwrite=True):\n\n ''' Use VMWare's filemanager api to push a file over http '''\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n # the api requires a filesize in bytes\n filesize = None\n fdata = None\n try:\n #filesize = os.path.getsize(src)\n filesize = os.stat(src).st_size\n fdata = None\n with open(src, 'rb') as f:\n fdata = f.read()\n result['local_filesize'] = filesize\n except Exception as e:\n result['failed'] = True\n result['msg'] = \"Unable to read src file: %s\" % str(e)\n return result\n\n # https://www.vmware.com/support/developer/converter-sdk/conv60_apireference/vim.vm.guest.FileManager.html#initiateFileTransferToGuest\n file_attribute = vim.vm.guest.FileManager.FileAttributes()\n url = self.content.guestOperationsManager.fileManager. \\\n InitiateFileTransferToGuest(vm, creds, dest, file_attribute, \n filesize, overwrite)\n\n # PUT the filedata to the url ...\n rsp, info = fetch_url(self.module, url, method=\"put\", data=fdata,\n use_proxy=False, force=True, last_mod_time=None, \n timeout=10, headers=None)\n\n result['msg'] = str(rsp.read())\n\n # save all of the transfer data\n for k,v in info.iteritems():\n result[k] = v\n\n return result\n\n\n def run_command_in_guest(self, vm, username, password, program_path, program_args, program_cwd, program_env):\n\n result = {'failed': False}\n\n tools_status = vm.guest.toolsStatus\n if (tools_status == 'toolsNotInstalled' or\n tools_status == 'toolsNotRunning'):\n result['failed'] = True\n result['msg'] = \"VMwareTools is not installed or is not running in the guest\"\n return result\n\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/NamePasswordAuthentication.rst\n creds = vim.vm.guest.NamePasswordAuthentication(\n username=username, password=password\n )\n\n res = None\n pdata = None\n try:\n # https://github.com/vmware/pyvmomi/blob/master/docs/vim/vm/guest/ProcessManager.rst\n pm = self.content.guestOperationsManager.processManager\n # https://www.vmware.com/support/developer/converter-sdk/conv51_apireference/vim.vm.guest.ProcessManager.ProgramSpec.html\n ps = vim.vm.guest.ProcessManager.ProgramSpec(\n #programPath=program,\n #arguments=args\n programPath=program_path,\n arguments=program_args,\n workingDirectory=program_cwd,\n )\n res = pm.StartProgramInGuest(vm, creds, ps)\n result['pid'] = res\n pdata = pm.ListProcessesInGuest(vm, creds, [res])\n\n # wait for pid to finish\n while not pdata[0].endTime:\n time.sleep(1)\n pdata = pm.ListProcessesInGuest(vm, creds, [res])\n result['owner'] = pdata[0].owner\n result['startTime'] = pdata[0].startTime.isoformat()\n result['endTime'] = pdata[0].endTime.isoformat()\n result['exitCode'] = pdata[0].exitCode\n if result['exitCode'] != 0:\n result['failed'] = True\n result['msg'] = \"program exited non-zero\"\n else:\n result['msg'] = \"program completed successfully\"\n\n except Exception as e:\n result['msg'] = str(e)\n result['failed'] = True\n\n return result\n\n def list_snapshots_recursively(self, snapshots):\n snapshot_data = []\n snap_text = ''\n for snapshot in snapshots:\n snap_text = 'Id: %s; Name: %s; Description: %s; CreateTime: %s; State: %s'%(snapshot.id, snapshot.name,\n snapshot.description, snapshot.createTime, snapshot.state)\n snapshot_data.append(snap_text)\n snapshot_data = snapshot_data + self.list_snapshots_recursively(snapshot.childSnapshotList)\n return snapshot_data\n\n\n def get_snapshots_by_name_recursively(self, snapshots, snapname):\n snap_obj = []\n for snapshot in snapshots:\n if snapshot.name == snapname:\n snap_obj.append(snapshot)\n else:\n snap_obj = snap_obj + self.get_snapshots_by_name_recursively(snapshot.childSnapshotList, snapname)\n return snap_obj\n\n def get_current_snap_obj(self, snapshots, snapob):\n snap_obj = []\n for snapshot in snapshots:\n if snapshot.snapshot == snapob:\n snap_obj.append(snapshot)\n snap_obj = snap_obj + self.get_current_snap_obj(snapshot.childSnapshotList, snapob)\n return snap_obj\n\n def snapshot_vm(self, vm, guest, snapshot_op):\n ''' To perform snapshot operations create/remove/revert/list_all/list_current/remove_all '''\n\n try:\n snapshot_op_name = snapshot_op['op_type']\n except KeyError:\n self.module.fail_json(msg=\"Specify op_type - create/remove/revert/list_all/list_current/remove_all\")\n\n task = None\n result = {}\n\n if snapshot_op_name not in ['create', 'remove', 'revert', 'list_all', 'list_current', 'remove_all']:\n self.module.fail_json(msg=\"Specify op_type - create/remove/revert/list_all/list_current/remove_all\")\n\n if snapshot_op_name != 'create' and vm.snapshot is None:\n self.module.exit_json(msg=\"VM - %s doesn't have any snapshots\"%guest)\n\n if snapshot_op_name == 'create':\n try:\n snapname = snapshot_op['name']\n except KeyError:\n self.module.fail_json(msg=\"specify name & description(optional) to create a snapshot\")\n\n if 'description' in snapshot_op:\n snapdesc = snapshot_op['description']\n else:\n snapdesc = ''\n\n dumpMemory = False\n quiesce = False\n task = vm.CreateSnapshot(snapname, snapdesc, dumpMemory, quiesce)\n\n elif snapshot_op_name in ['remove', 'revert']:\n try:\n snapname = snapshot_op['name']\n except KeyError:\n self.module.fail_json(msg=\"specify snapshot name\")\n\n snap_obj = self.get_snapshots_by_name_recursively(vm.snapshot.rootSnapshotList, snapname)\n\n #if len(snap_obj) is 0; then no snapshots with specified name\n if len(snap_obj) == 1:\n snap_obj = snap_obj[0].snapshot\n if snapshot_op_name == 'remove':\n task = snap_obj.RemoveSnapshot_Task(True)\n else:\n task = snap_obj.RevertToSnapshot_Task()\n else:\n self.module.exit_json(msg=\"Couldn't find any snapshots with specified name: %s on VM: %s\"%(snapname, guest))\n\n elif snapshot_op_name == 'list_all':\n snapshot_data = self.list_snapshots_recursively(vm.snapshot.rootSnapshotList)\n result['snapshot_data'] = snapshot_data\n\n elif snapshot_op_name == 'list_current':\n current_snapref = vm.snapshot.currentSnapshot\n current_snap_obj = self.get_current_snap_obj(vm.snapshot.rootSnapshotList, current_snapref)\n result['current_snapshot'] = 'Id: %s; Name: %s; Description: %s; CreateTime: %s; State: %s'%(current_snap_obj[0].id,\n current_snap_obj[0].name, current_snap_obj[0].description, current_snap_obj[0].createTime,\n current_snap_obj[0].state)\n\n elif snapshot_op_name == 'remove_all':\n task = vm.RemoveAllSnapshots()\n\n if task:\n self.wait_for_task(task)\n if task.info.state == 'error':\n result = {'changed': False, 'failed': True, 'msg': task.info.error.msg}\n else:\n result = {'changed': True, 'failed': False}\n\n return result\n\ndef get_obj(content, vimtype, name):\n \"\"\"\n Return an object by name, if name is None the\n first found object is returned\n \"\"\"\n obj = None\n container = content.viewManager.CreateContainerView(\n content.rootFolder, vimtype, True)\n for c in container.view:\n if name:\n if c.name == name:\n obj = c\n break\n else:\n obj = c\n break\n\n container.Destroy()\n return obj\n\n\ndef main():\n\n vm = None\n\n module = AnsibleModule(\n argument_spec=dict(\n hostname=dict(\n type='str',\n default=os.environ.get('VMWARE_HOST')\n ),\n username=dict(\n type='str',\n default=os.environ.get('VMWARE_USER')\n ),\n password=dict(\n type='str', no_log=True,\n default=os.environ.get('VMWARE_PASSWORD')\n ),\n state=dict(\n required=False,\n choices=[\n 'poweredon',\n 'poweredoff',\n 'present',\n 'absent',\n 'restarted',\n 'reconfigured'\n ],\n default='present'),\n validate_certs=dict(required=False, type='bool', default=True),\n template_src=dict(required=False, type='str', aliases=['template']),\n annotation=dict(required=False, type='str', aliases=['notes']),\n name=dict(required=True, type='str'),\n name_match=dict(required=False, type='str', default='first'),\n snapshot_op=dict(required=False, type='dict', default={}),\n uuid=dict(required=False, type='str'),\n folder=dict(required=False, type='str', default='/vm', aliases=['folder']),\n disk=dict(required=False, type='list'),\n nic=dict(required=False, type='list'),\n hardware=dict(required=False, type='dict', default={}),\n force=dict(required=False, type='bool', default=False),\n datacenter=dict(required=False, type='str', default=None),\n esxi_hostname=dict(required=False, type='str', default=None),\n cluster=dict(required=False, type='str', default=None),\n wait_for_ip_address=dict(required=False, type='bool', default=True),\n customize=dict(required=False, type='bool', default=False),\n ips=dict(required=False, type='str', default=None),\n dns_servers=dict(required=False, type='list', default=None),\n domain=dict(required=False, type='str', default=None),\n networks=dict(required=False, type='dict', default={})\n ),\n supports_check_mode=True,\n mutually_exclusive=[],\n required_together=[\n ['state', 'force'],\n ['template'],\n ],\n )\n\n pyv = PyVmomiHelper(module)\n\n # Check if the VM exists before continuing\n vm = pyv.getvm(name=module.params['name'], \n folder=module.params['folder'], \n uuid=module.params['uuid'], \n name_match=module.params['name_match'])\n\n # VM already exists\n if vm:\n\n if module.params['state'] == 'absent':\n # destroy it\n if module.params['force']:\n # has to be poweredoff first\n result = pyv.set_powerstate(vm, 'poweredoff', module.params['force'])\n result = pyv.remove_vm(vm)\n elif module.params['state'] in ['poweredon', 'poweredoff', 'restarted']:\n # set powerstate\n result = pyv.set_powerstate(vm, module.params['state'], module.params['force'])\n elif module.params['snapshot_op']:\n result = pyv.snapshot_vm(vm, module.params['name'], module.params['snapshot_op'])\n else:\n # Run for facts only\n try:\n module.exit_json(instance=pyv.gather_facts(vm))\n except Exception:\n e = get_exception()\n module.fail_json(\n msg=\"Fact gather failed with exception %s\" % e)\n\n # VM doesn't exist\n else:\n create_states = ['poweredon', 'poweredoff', 'present', 'restarted']\n if module.params['state'] in create_states:\n poweron = (module.params['state'] != 'poweredoff')\n # Create it ...\n result = pyv.deploy_template(\n poweron=poweron, \n wait_for_ip=module.params['wait_for_ip_address']\n )\n result['changed'] = True\n elif module.params['state'] == 'absent':\n result = {'changed': False, 'failed': False}\n else:\n result = {'changed': False, 'failed': False}\n\n # FIXME\n if not 'failed' in result:\n result['failed'] = False\n\n if result['failed']:\n module.fail_json(result)\n else:\n module.exit_json(*result)\n\n\nfrom ansible.module_utils.vmware import \nfrom ansible.module_utils.basic import *\n\nif __name__ == '__main__':\n main()\n", "path": "cloud/vmware/vmware_guest.py" } ]	diff --git a/cloud/vmware/vmware_guest.py b/cloud/vmware/vmware_guest.py index cc520432de4..2a749bda674 100644 --- a/cloud/vmware/vmware_guest.py +++ b/cloud/vmware/vmware_guest.py @@ -88,7 +88,7 @@ esxi_hostname: description: - The esxi hostname where the VM will run. - required: True + required: False annotation: description: - A note or annotation to include in the VM
pyro-ppl__numpyro-1589	mnist loader should not scale the label Scaling the label as in [this line](https://github.com/pyro-ppl/numpyro/blob/db2913b61b1d82fcad6662eb4d25ce5808f46d00/numpyro/examples/datasets.py#L167) seems wrong to me.	[ { "content": "# Copyright Contributors to the Pyro project.\n# SPDX-License-Identifier: Apache-2.0\n\nfrom collections import namedtuple\nimport csv\nimport gzip\nimport io\nimport os\nimport pickle\nimport struct\nfrom urllib.parse import urlparse\nfrom urllib.request import urlretrieve\nimport warnings\nimport zipfile\n\nimport numpy as np\n\nfrom jax import lax\n\nfrom numpyro.util import find_stack_level\n\nif \"CI\" in os.environ:\n DATA_DIR = os.path.expanduser(\"~/.data\")\nelse:\n DATA_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), \".data\"))\nos.makedirs(DATA_DIR, exist_ok=True)\n\ndset = namedtuple(\"dset\", [\"name\", \"urls\"])\n\nBASEBALL = dset(\n \"baseball\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/EfronMorrisBB.txt\"]\n)\n\nBOSTON_HOUSING = dset(\n \"boston_housing\",\n [\"https://archive.ics.uci.edu/ml/machine-learning-databases/housing/housing.data\"],\n)\n\nCOVTYPE = dset(\n \"covtype\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/covtype.zip\"]\n)\n\nDIPPER_VOLE = dset(\n \"dipper_vole\",\n [\"https://github.com/pyro-ppl/datasets/blob/master/dipper_vole.zip?raw=true\"],\n)\n\nMNIST = dset(\n \"mnist\",\n [\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/train-images-idx3-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/train-labels-idx1-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/t10k-images-idx3-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/t10k-labels-idx1-ubyte.gz\",\n ],\n)\n\nSP500 = dset(\"SP500\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/SP500.csv\"])\n\nUCBADMIT = dset(\n \"ucbadmit\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/UCBadmit.csv\"]\n)\n\nLYNXHARE = dset(\n \"lynxhare\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/LynxHare.txt\"]\n)\n\nJSB_CHORALES = dset(\n \"jsb_chorales\",\n [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/polyphonic/jsb_chorales.pickle\"],\n)\n\nHIGGS = dset(\n \"higgs\",\n [\"https://archive.ics.uci.edu/ml/machine-learning-databases/00280/HIGGS.csv.gz\"],\n)\n\nNINE_MERS = dset(\n \"9mers\",\n [\"https://github.com/pyro-ppl/datasets/blob/master/9mers_data.pkl?raw=true\"],\n)\n\nMORTALITY = dset(\n \"mortality\",\n [\n \"https://github.com/pyro-ppl/datasets/blob/master/simulated_mortality.csv?raw=true\"\n ],\n)\n\n\ndef _download(dset):\n for url in dset.urls:\n file = os.path.basename(urlparse(url).path)\n out_path = os.path.join(DATA_DIR, file)\n if not os.path.exists(out_path):\n print(\"Downloading - {}.\".format(url))\n urlretrieve(url, out_path)\n print(\"Download complete.\")\n\n\ndef _load_baseball():\n _download(BASEBALL)\n\n def train_test_split(file):\n train, test, player_names = [], [], []\n with open(file, \"r\") as f:\n csv_reader = csv.DictReader(f, delimiter=\"\\t\", quoting=csv.QUOTE_NONE)\n for row in csv_reader:\n player_names.append(row[\"FirstName\"] + \" \" + row[\"LastName\"])\n at_bats, hits = row[\"At-Bats\"], row[\"Hits\"]\n train.append(np.array([int(at_bats), int(hits)]))\n season_at_bats, season_hits = row[\"SeasonAt-Bats\"], row[\"SeasonHits\"]\n test.append(np.array([int(season_at_bats), int(season_hits)]))\n return np.stack(train), np.stack(test), player_names\n\n train, test, player_names = train_test_split(\n os.path.join(DATA_DIR, \"EfronMorrisBB.txt\")\n )\n return {\"train\": (train, player_names), \"test\": (test, player_names)}\n\n\ndef _load_boston_housing():\n _download(BOSTON_HOUSING)\n file_path = os.path.join(DATA_DIR, \"housing.data\")\n data = np.loadtxt(file_path)\n return {\"train\": (data[:, :-1], data[:, -1])}\n\n\ndef _load_covtype():\n _download(COVTYPE)\n\n file_path = os.path.join(DATA_DIR, \"covtype.zip\")\n data = np.load(file_path)\n\n return {\"train\": (data[\"data\"], data[\"target\"])}\n\n\ndef _load_dipper_vole():\n _download(DIPPER_VOLE)\n\n file_path = os.path.join(DATA_DIR, \"dipper_vole.zip\")\n data = {}\n with zipfile.ZipFile(file_path) as zipper:\n data[\"dipper\"] = (\n np.genfromtxt(zipper.open(\"dipper_capture_history.csv\"), delimiter=\",\")[\n :, 1:\n ].astype(int),\n np.genfromtxt(zipper.open(\"dipper_sex.csv\"), delimiter=\",\")[:, 1].astype(\n int\n ),\n )\n data[\"vole\"] = (\n np.genfromtxt(\n zipper.open(\"meadow_voles_capture_history.csv\"), delimiter=\",\"\n )[:, 1:],\n )\n\n return data\n\n\ndef _load_mnist():\n _download(MNIST)\n\n def read_label(file):\n with gzip.open(file, \"rb\") as f:\n f.read(8)\n data = np.frombuffer(f.read(), dtype=np.int8) / np.float32(255.0)\n return data\n\n def read_img(file):\n with gzip.open(file, \"rb\") as f:\n _, _, nrows, ncols = struct.unpack(\">IIII\", f.read(16))\n data = np.frombuffer(f.read(), dtype=np.uint8) / np.float32(255.0)\n return data.reshape(-1, nrows, ncols)\n\n files = [\n os.path.join(DATA_DIR, os.path.basename(urlparse(url).path))\n for url in MNIST.urls\n ]\n return {\n \"train\": (read_img(files[0]), read_label(files[1])),\n \"test\": (read_img(files[2]), read_label(files[3])),\n }\n\n\ndef _load_sp500():\n _download(SP500)\n\n date, value = [], []\n with open(os.path.join(DATA_DIR, \"SP500.csv\"), \"r\") as f:\n csv_reader = csv.DictReader(f, quoting=csv.QUOTE_NONE)\n for row in csv_reader:\n date.append(row[\"DATE\"])\n value.append(float(row[\"VALUE\"]))\n value = np.stack(value)\n\n return {\"train\": (date, value)}\n\n\ndef _load_ucbadmit():\n _download(UCBADMIT)\n\n dept, male, applications, admit = [], [], [], []\n with open(os.path.join(DATA_DIR, \"UCBadmit.csv\")) as f:\n csv_reader = csv.DictReader(\n f,\n delimiter=\";\",\n fieldnames=[\"index\", \"dept\", \"gender\", \"admit\", \"reject\", \"applications\"],\n )\n next(csv_reader) # skip the first row\n for row in csv_reader:\n dept.append(ord(row[\"dept\"]) - ord(\"A\"))\n male.append(row[\"gender\"] == \"male\")\n applications.append(int(row[\"applications\"]))\n admit.append(int(row[\"admit\"]))\n\n return {\n \"train\": (\n np.stack(dept),\n np.stack(male),\n np.stack(applications),\n np.stack(admit),\n )\n }\n\n\ndef _load_lynxhare():\n _download(LYNXHARE)\n\n file_path = os.path.join(DATA_DIR, \"LynxHare.txt\")\n data = np.loadtxt(file_path)\n\n return {\"train\": (data[:, 0].astype(int), data[:, 1:])}\n\n\ndef _pad_sequence(sequences):\n # like torch.nn.utils.rnn.pad_sequence with batch_first=True\n max_length = max(x.shape[0] for x in sequences)\n padded_sequences = []\n for x in sequences:\n pad = [(0, 0)] * np.ndim(x)\n pad[0] = (0, max_length - x.shape[0])\n padded_sequences.append(np.pad(x, pad))\n return np.stack(padded_sequences)\n\n\ndef _load_jsb_chorales():\n _download(JSB_CHORALES)\n\n file_path = os.path.join(DATA_DIR, \"jsb_chorales.pickle\")\n with open(file_path, \"rb\") as f:\n data = pickle.load(f)\n\n # XXX: we might expose those in `load_dataset` keywords\n min_note = 21\n note_range = 88\n processed_dataset = {}\n for split, data_split in data.items():\n processed_dataset[split] = {}\n n_seqs = len(data_split)\n processed_dataset[split][\"sequence_lengths\"] = np.zeros(n_seqs, dtype=int)\n processed_dataset[split][\"sequences\"] = []\n for seq in range(n_seqs):\n seq_length = len(data_split[seq])\n processed_dataset[split][\"sequence_lengths\"][seq] = seq_length\n processed_sequence = np.zeros((seq_length, note_range))\n for t in range(seq_length):\n note_slice = np.array(list(data_split[seq][t])) - min_note\n slice_length = len(note_slice)\n if slice_length > 0:\n processed_sequence[t, note_slice] = np.ones(slice_length)\n processed_dataset[split][\"sequences\"].append(processed_sequence)\n\n for k, v in processed_dataset.items():\n lengths = v[\"sequence_lengths\"]\n sequences = v[\"sequences\"]\n processed_dataset[k] = (lengths, _pad_sequence(sequences).astype(\"int32\"))\n return processed_dataset\n\n\ndef _load_higgs(num_datapoints):\n warnings.warn(\n \"Higgs is a 2.6 GB dataset\",\n stacklevel=find_stack_level(),\n )\n _download(HIGGS)\n\n file_path = os.path.join(DATA_DIR, \"HIGGS.csv.gz\")\n with io.TextIOWrapper(gzip.open(file_path, \"rb\")) as f:\n csv_reader = csv.reader(f, delimiter=\",\", quoting=csv.QUOTE_NONE)\n obs = []\n data = []\n for i, row in enumerate(csv_reader):\n obs.append(int(float(row[0])))\n data.append([float(v) for v in row[1:]])\n if num_datapoints and i > num_datapoints:\n break\n obs = np.stack(obs)\n data = np.stack(data)\n (n,) = obs.shape\n\n return {\n \"train\": (data[: -(n // 20)], obs[: -(n // 20)]),\n \"test\": (data[-(n // 20) :], obs[-(n // 20) :]),\n } # standard split -500_000: as test\n\n\ndef _load_9mers():\n _download(NINE_MERS)\n file_path = os.path.join(DATA_DIR, \"9mers_data.pkl\")\n return pickle.load(open(file_path, \"rb\"))\n\n\ndef _load_mortality():\n _download(MORTALITY)\n\n a, s1, s2, t, deaths, population = [], [], [], [], [], []\n with open(os.path.join(DATA_DIR, \"simulated_mortality.csv\")) as f:\n csv_reader = csv.DictReader(\n f,\n fieldnames=[\n \"age_group\",\n \"year\",\n \"a\",\n \"s1\",\n \"s2\",\n \"t\",\n \"deaths\",\n \"population\",\n ],\n )\n next(csv_reader) # skip the first row\n for row in csv_reader:\n a.append(int(row[\"a\"]))\n s1.append(int(row[\"s1\"]))\n s2.append(int(row[\"s2\"]))\n t.append(int(row[\"t\"]))\n deaths.append(int(row[\"deaths\"]))\n population.append(int(row[\"population\"]))\n\n return {\n \"train\": (\n np.stack(a),\n np.stack(s1),\n np.stack(s2),\n np.stack(t),\n np.stack(deaths),\n np.stack(population),\n )\n }\n\n\ndef _load(dset, num_datapoints=-1):\n if dset == BASEBALL:\n return _load_baseball()\n elif dset == BOSTON_HOUSING:\n return _load_boston_housing()\n elif dset == COVTYPE:\n return _load_covtype()\n elif dset == DIPPER_VOLE:\n return _load_dipper_vole()\n elif dset == MNIST:\n return _load_mnist()\n elif dset == SP500:\n return _load_sp500()\n elif dset == UCBADMIT:\n return _load_ucbadmit()\n elif dset == LYNXHARE:\n return _load_lynxhare()\n elif dset == JSB_CHORALES:\n return _load_jsb_chorales()\n elif dset == HIGGS:\n return _load_higgs(num_datapoints)\n elif dset == NINE_MERS:\n return _load_9mers()\n elif dset == MORTALITY:\n return _load_mortality()\n raise ValueError(\"Dataset - {} not found.\".format(dset.name))\n\n\ndef iter_dataset(dset, batch_size=None, split=\"train\", shuffle=True):\n arrays = _load(dset)[split]\n num_records = len(arrays[0])\n idxs = np.arange(num_records)\n if not batch_size:\n batch_size = num_records\n if shuffle:\n idxs = np.random.permutation(idxs)\n for i in range(num_records // batch_size):\n start_idx = i * batch_size\n end_idx = min((i + 1) * batch_size, num_records)\n yield tuple(a[idxs[start_idx:end_idx]] for a in arrays)\n\n\ndef load_dataset(\n dset,\n batch_size=None,\n split=\"train\",\n shuffle=True,\n num_datapoints=None,\n):\n data = _load(dset, num_datapoints)\n if isinstance(data, dict):\n arrays = data[split]\n num_records = len(arrays[0])\n idxs = np.arange(num_records)\n if not batch_size:\n batch_size = num_records\n\n def init():\n return (\n num_records // batch_size,\n np.random.permutation(idxs) if shuffle else idxs,\n )\n\n def get_batch(i=0, idxs=idxs):\n ret_idx = lax.dynamic_slice_in_dim(idxs, i * batch_size, batch_size)\n return tuple(\n np.take(a, ret_idx, axis=0)\n if isinstance(a, list)\n else lax.index_take(a, (ret_idx,), axes=(0,))\n for a in arrays\n )\n\n return init, get_batch\n", "path": "numpyro/examples/datasets.py" } ]	[ { "content": "# Copyright Contributors to the Pyro project.\n# SPDX-License-Identifier: Apache-2.0\n\nfrom collections import namedtuple\nimport csv\nimport gzip\nimport io\nimport os\nimport pickle\nimport struct\nfrom urllib.parse import urlparse\nfrom urllib.request import urlretrieve\nimport warnings\nimport zipfile\n\nimport numpy as np\n\nfrom jax import lax\n\nfrom numpyro.util import find_stack_level\n\nif \"CI\" in os.environ:\n DATA_DIR = os.path.expanduser(\"~/.data\")\nelse:\n DATA_DIR = os.path.abspath(os.path.join(os.path.dirname(__file__), \".data\"))\nos.makedirs(DATA_DIR, exist_ok=True)\n\ndset = namedtuple(\"dset\", [\"name\", \"urls\"])\n\nBASEBALL = dset(\n \"baseball\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/EfronMorrisBB.txt\"]\n)\n\nBOSTON_HOUSING = dset(\n \"boston_housing\",\n [\"https://archive.ics.uci.edu/ml/machine-learning-databases/housing/housing.data\"],\n)\n\nCOVTYPE = dset(\n \"covtype\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/covtype.zip\"]\n)\n\nDIPPER_VOLE = dset(\n \"dipper_vole\",\n [\"https://github.com/pyro-ppl/datasets/blob/master/dipper_vole.zip?raw=true\"],\n)\n\nMNIST = dset(\n \"mnist\",\n [\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/train-images-idx3-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/train-labels-idx1-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/t10k-images-idx3-ubyte.gz\",\n \"https://d2hg8soec8ck9v.cloudfront.net/datasets/mnist/t10k-labels-idx1-ubyte.gz\",\n ],\n)\n\nSP500 = dset(\"SP500\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/SP500.csv\"])\n\nUCBADMIT = dset(\n \"ucbadmit\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/UCBadmit.csv\"]\n)\n\nLYNXHARE = dset(\n \"lynxhare\", [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/LynxHare.txt\"]\n)\n\nJSB_CHORALES = dset(\n \"jsb_chorales\",\n [\"https://d2hg8soec8ck9v.cloudfront.net/datasets/polyphonic/jsb_chorales.pickle\"],\n)\n\nHIGGS = dset(\n \"higgs\",\n [\"https://archive.ics.uci.edu/ml/machine-learning-databases/00280/HIGGS.csv.gz\"],\n)\n\nNINE_MERS = dset(\n \"9mers\",\n [\"https://github.com/pyro-ppl/datasets/blob/master/9mers_data.pkl?raw=true\"],\n)\n\nMORTALITY = dset(\n \"mortality\",\n [\n \"https://github.com/pyro-ppl/datasets/blob/master/simulated_mortality.csv?raw=true\"\n ],\n)\n\n\ndef _download(dset):\n for url in dset.urls:\n file = os.path.basename(urlparse(url).path)\n out_path = os.path.join(DATA_DIR, file)\n if not os.path.exists(out_path):\n print(\"Downloading - {}.\".format(url))\n urlretrieve(url, out_path)\n print(\"Download complete.\")\n\n\ndef _load_baseball():\n _download(BASEBALL)\n\n def train_test_split(file):\n train, test, player_names = [], [], []\n with open(file, \"r\") as f:\n csv_reader = csv.DictReader(f, delimiter=\"\\t\", quoting=csv.QUOTE_NONE)\n for row in csv_reader:\n player_names.append(row[\"FirstName\"] + \" \" + row[\"LastName\"])\n at_bats, hits = row[\"At-Bats\"], row[\"Hits\"]\n train.append(np.array([int(at_bats), int(hits)]))\n season_at_bats, season_hits = row[\"SeasonAt-Bats\"], row[\"SeasonHits\"]\n test.append(np.array([int(season_at_bats), int(season_hits)]))\n return np.stack(train), np.stack(test), player_names\n\n train, test, player_names = train_test_split(\n os.path.join(DATA_DIR, \"EfronMorrisBB.txt\")\n )\n return {\"train\": (train, player_names), \"test\": (test, player_names)}\n\n\ndef _load_boston_housing():\n _download(BOSTON_HOUSING)\n file_path = os.path.join(DATA_DIR, \"housing.data\")\n data = np.loadtxt(file_path)\n return {\"train\": (data[:, :-1], data[:, -1])}\n\n\ndef _load_covtype():\n _download(COVTYPE)\n\n file_path = os.path.join(DATA_DIR, \"covtype.zip\")\n data = np.load(file_path)\n\n return {\"train\": (data[\"data\"], data[\"target\"])}\n\n\ndef _load_dipper_vole():\n _download(DIPPER_VOLE)\n\n file_path = os.path.join(DATA_DIR, \"dipper_vole.zip\")\n data = {}\n with zipfile.ZipFile(file_path) as zipper:\n data[\"dipper\"] = (\n np.genfromtxt(zipper.open(\"dipper_capture_history.csv\"), delimiter=\",\")[\n :, 1:\n ].astype(int),\n np.genfromtxt(zipper.open(\"dipper_sex.csv\"), delimiter=\",\")[:, 1].astype(\n int\n ),\n )\n data[\"vole\"] = (\n np.genfromtxt(\n zipper.open(\"meadow_voles_capture_history.csv\"), delimiter=\",\"\n )[:, 1:],\n )\n\n return data\n\n\ndef _load_mnist():\n _download(MNIST)\n\n def read_label(file):\n with gzip.open(file, \"rb\") as f:\n f.read(8)\n data = np.frombuffer(f.read(), dtype=np.int8)\n return data\n\n def read_img(file):\n with gzip.open(file, \"rb\") as f:\n _, _, nrows, ncols = struct.unpack(\">IIII\", f.read(16))\n data = np.frombuffer(f.read(), dtype=np.uint8) / np.float32(255.0)\n return data.reshape(-1, nrows, ncols)\n\n files = [\n os.path.join(DATA_DIR, os.path.basename(urlparse(url).path))\n for url in MNIST.urls\n ]\n return {\n \"train\": (read_img(files[0]), read_label(files[1])),\n \"test\": (read_img(files[2]), read_label(files[3])),\n }\n\n\ndef _load_sp500():\n _download(SP500)\n\n date, value = [], []\n with open(os.path.join(DATA_DIR, \"SP500.csv\"), \"r\") as f:\n csv_reader = csv.DictReader(f, quoting=csv.QUOTE_NONE)\n for row in csv_reader:\n date.append(row[\"DATE\"])\n value.append(float(row[\"VALUE\"]))\n value = np.stack(value)\n\n return {\"train\": (date, value)}\n\n\ndef _load_ucbadmit():\n _download(UCBADMIT)\n\n dept, male, applications, admit = [], [], [], []\n with open(os.path.join(DATA_DIR, \"UCBadmit.csv\")) as f:\n csv_reader = csv.DictReader(\n f,\n delimiter=\";\",\n fieldnames=[\"index\", \"dept\", \"gender\", \"admit\", \"reject\", \"applications\"],\n )\n next(csv_reader) # skip the first row\n for row in csv_reader:\n dept.append(ord(row[\"dept\"]) - ord(\"A\"))\n male.append(row[\"gender\"] == \"male\")\n applications.append(int(row[\"applications\"]))\n admit.append(int(row[\"admit\"]))\n\n return {\n \"train\": (\n np.stack(dept),\n np.stack(male),\n np.stack(applications),\n np.stack(admit),\n )\n }\n\n\ndef _load_lynxhare():\n _download(LYNXHARE)\n\n file_path = os.path.join(DATA_DIR, \"LynxHare.txt\")\n data = np.loadtxt(file_path)\n\n return {\"train\": (data[:, 0].astype(int), data[:, 1:])}\n\n\ndef _pad_sequence(sequences):\n # like torch.nn.utils.rnn.pad_sequence with batch_first=True\n max_length = max(x.shape[0] for x in sequences)\n padded_sequences = []\n for x in sequences:\n pad = [(0, 0)] * np.ndim(x)\n pad[0] = (0, max_length - x.shape[0])\n padded_sequences.append(np.pad(x, pad))\n return np.stack(padded_sequences)\n\n\ndef _load_jsb_chorales():\n _download(JSB_CHORALES)\n\n file_path = os.path.join(DATA_DIR, \"jsb_chorales.pickle\")\n with open(file_path, \"rb\") as f:\n data = pickle.load(f)\n\n # XXX: we might expose those in `load_dataset` keywords\n min_note = 21\n note_range = 88\n processed_dataset = {}\n for split, data_split in data.items():\n processed_dataset[split] = {}\n n_seqs = len(data_split)\n processed_dataset[split][\"sequence_lengths\"] = np.zeros(n_seqs, dtype=int)\n processed_dataset[split][\"sequences\"] = []\n for seq in range(n_seqs):\n seq_length = len(data_split[seq])\n processed_dataset[split][\"sequence_lengths\"][seq] = seq_length\n processed_sequence = np.zeros((seq_length, note_range))\n for t in range(seq_length):\n note_slice = np.array(list(data_split[seq][t])) - min_note\n slice_length = len(note_slice)\n if slice_length > 0:\n processed_sequence[t, note_slice] = np.ones(slice_length)\n processed_dataset[split][\"sequences\"].append(processed_sequence)\n\n for k, v in processed_dataset.items():\n lengths = v[\"sequence_lengths\"]\n sequences = v[\"sequences\"]\n processed_dataset[k] = (lengths, _pad_sequence(sequences).astype(\"int32\"))\n return processed_dataset\n\n\ndef _load_higgs(num_datapoints):\n warnings.warn(\n \"Higgs is a 2.6 GB dataset\",\n stacklevel=find_stack_level(),\n )\n _download(HIGGS)\n\n file_path = os.path.join(DATA_DIR, \"HIGGS.csv.gz\")\n with io.TextIOWrapper(gzip.open(file_path, \"rb\")) as f:\n csv_reader = csv.reader(f, delimiter=\",\", quoting=csv.QUOTE_NONE)\n obs = []\n data = []\n for i, row in enumerate(csv_reader):\n obs.append(int(float(row[0])))\n data.append([float(v) for v in row[1:]])\n if num_datapoints and i > num_datapoints:\n break\n obs = np.stack(obs)\n data = np.stack(data)\n (n,) = obs.shape\n\n return {\n \"train\": (data[: -(n // 20)], obs[: -(n // 20)]),\n \"test\": (data[-(n // 20) :], obs[-(n // 20) :]),\n } # standard split -500_000: as test\n\n\ndef _load_9mers():\n _download(NINE_MERS)\n file_path = os.path.join(DATA_DIR, \"9mers_data.pkl\")\n return pickle.load(open(file_path, \"rb\"))\n\n\ndef _load_mortality():\n _download(MORTALITY)\n\n a, s1, s2, t, deaths, population = [], [], [], [], [], []\n with open(os.path.join(DATA_DIR, \"simulated_mortality.csv\")) as f:\n csv_reader = csv.DictReader(\n f,\n fieldnames=[\n \"age_group\",\n \"year\",\n \"a\",\n \"s1\",\n \"s2\",\n \"t\",\n \"deaths\",\n \"population\",\n ],\n )\n next(csv_reader) # skip the first row\n for row in csv_reader:\n a.append(int(row[\"a\"]))\n s1.append(int(row[\"s1\"]))\n s2.append(int(row[\"s2\"]))\n t.append(int(row[\"t\"]))\n deaths.append(int(row[\"deaths\"]))\n population.append(int(row[\"population\"]))\n\n return {\n \"train\": (\n np.stack(a),\n np.stack(s1),\n np.stack(s2),\n np.stack(t),\n np.stack(deaths),\n np.stack(population),\n )\n }\n\n\ndef _load(dset, num_datapoints=-1):\n if dset == BASEBALL:\n return _load_baseball()\n elif dset == BOSTON_HOUSING:\n return _load_boston_housing()\n elif dset == COVTYPE:\n return _load_covtype()\n elif dset == DIPPER_VOLE:\n return _load_dipper_vole()\n elif dset == MNIST:\n return _load_mnist()\n elif dset == SP500:\n return _load_sp500()\n elif dset == UCBADMIT:\n return _load_ucbadmit()\n elif dset == LYNXHARE:\n return _load_lynxhare()\n elif dset == JSB_CHORALES:\n return _load_jsb_chorales()\n elif dset == HIGGS:\n return _load_higgs(num_datapoints)\n elif dset == NINE_MERS:\n return _load_9mers()\n elif dset == MORTALITY:\n return _load_mortality()\n raise ValueError(\"Dataset - {} not found.\".format(dset.name))\n\n\ndef iter_dataset(dset, batch_size=None, split=\"train\", shuffle=True):\n arrays = _load(dset)[split]\n num_records = len(arrays[0])\n idxs = np.arange(num_records)\n if not batch_size:\n batch_size = num_records\n if shuffle:\n idxs = np.random.permutation(idxs)\n for i in range(num_records // batch_size):\n start_idx = i * batch_size\n end_idx = min((i + 1) * batch_size, num_records)\n yield tuple(a[idxs[start_idx:end_idx]] for a in arrays)\n\n\ndef load_dataset(\n dset,\n batch_size=None,\n split=\"train\",\n shuffle=True,\n num_datapoints=None,\n):\n data = _load(dset, num_datapoints)\n if isinstance(data, dict):\n arrays = data[split]\n num_records = len(arrays[0])\n idxs = np.arange(num_records)\n if not batch_size:\n batch_size = num_records\n\n def init():\n return (\n num_records // batch_size,\n np.random.permutation(idxs) if shuffle else idxs,\n )\n\n def get_batch(i=0, idxs=idxs):\n ret_idx = lax.dynamic_slice_in_dim(idxs, i * batch_size, batch_size)\n return tuple(\n np.take(a, ret_idx, axis=0)\n if isinstance(a, list)\n else lax.index_take(a, (ret_idx,), axes=(0,))\n for a in arrays\n )\n\n return init, get_batch\n", "path": "numpyro/examples/datasets.py" } ]	diff --git a/numpyro/examples/datasets.py b/numpyro/examples/datasets.py index 927e60b3a..f04a56b3c 100644 --- a/numpyro/examples/datasets.py +++ b/numpyro/examples/datasets.py @@ -164,7 +164,7 @@ def _load_mnist(): def read_label(file): with gzip.open(file, "rb") as f: f.read(8) - data = np.frombuffer(f.read(), dtype=np.int8) / np.float32(255.0) + data = np.frombuffer(f.read(), dtype=np.int8) return data def read_img(file):
pulp__pulpcore-4293	Querying content in repository versions with lots of content is slow Version All Describe the bug When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, however I have notice queries that can take anywhere from 200ms to 1000ms. This appears to be due to the complex joins that have to be made on version_added and version_removed. To Reproduce - Load up a repository with a lot of content - Perform a query to fetch the last 100 objects or count how many objects are in it - Observe query speeds that would make sonic the hedgehog faint Expected behavior Database queries should be fast. Hopefully less than 50ms for complex ones, ideally lower than that. Some possible solutions - Adding the repo version numbers directly to the RepositoryContent table speeds up queries greatly. My testing showed that this can lower the queryset speed to 80ms with 65k content in some cases. - pulp_ansible is experimenting with querying the repository version table to look up RepositoryContent (https://github.com/pulp/pulp_ansible/blob/main/pulp_ansible/app/utils.py#L5). Results have been mixed with this. In some cases the query efficiency is substantially higher (on the order of 8x improvement). In other cases, it's roughly the same. - Some form of memoization/caching of querysets.	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.contrib.postgres.fields import HStoreField\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import F, Func, Q, Value\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import (\n batch_qs,\n get_url,\n get_view_name_for_model,\n get_domain,\n get_domain_pk,\n cache_key,\n)\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n pulp_labels (HStoreField): Dictionary of string values.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n pulp_domain (models.ForeignKeyField): The domain the Repository is a part of.\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n class Meta:\n unique_together = (\"name\", \"pulp_domain\")\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n # lock the repository if it was created from within a running task\n task_id = Task.current_id()\n if task_id is None:\n return\n\n repository_url = Value(get_url(self))\n update_func = Func(\n F(\"reserved_resources_record\"), repository_url, function=\"ARRAY_APPEND\"\n )\n updated = Task.objects.filter(pk=task_id).update(\n reserved_resources_record=update_func\n )\n if not updated:\n raise RuntimeError(f\"The repository '{self.name}' could not be locked\")\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def initialize_new_version(self, new_version):\n \"\"\"\n Initialize the new RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before any other\n actions performed on the new `RepositoryVersion`.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n \"\"\"\n pass\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n \"Deleting repository version {} due to version retention limit.\".format(version)\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self, everything=False):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if everything:\n from .publication import Distribution, Publication\n\n versions = self.versions.all()\n pubs = Publication.objects.filter(repository_version__in=versions, complete=True)\n distributions \|= Distribution.objects.filter(publication__in=pubs)\n distributions \|= Distribution.objects.filter(repository_version__in=versions)\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n pulp_labels (HStoreField): Dictionary of string values.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits requests per second for each concurrent downloader\n\n Relations:\n\n pulp_domain (models.ForeignKey): The domain the Remote is a part of.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, download_factory=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n download_factory (:class:`~pulpcore.plugin.download.DownloadFactory`): The download\n factory to be used.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n if download_factory is None:\n download_factory = self.download_factory\n return download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None, request=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from relative path and request.\n\n This method returns the URL for a RemoteArtifact by concatenating the Remote's url and the\n relative path. Plugin writers are expected to override this method when a more complex\n algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n request (aiohttp.web.Request): The request object for this relative path\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method. This method can return None if the\n relative path is for metadata that should only be streamed from the remote and not saved.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Optional[Class]: The optional Class of the content type that should be available at the\n relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n\n class Meta:\n default_related_name = \"remotes\"\n unique_together = (\"name\", \"pulp_domain\")\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n # Content can only be removed once it's no longer referenced by any repository\n content = models.ForeignKey(\n \"Content\", on_delete=models.PROTECT, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n # version_added and version_removed need to be properly handled in _squash before the version\n # can be deleted\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.RESTRICT\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\",\n null=True,\n related_name=\"removed_memberships\",\n on_delete=models.RESTRICT,\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n info = models.JSONField(default=dict)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository_id=self.repository_id, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(version_memberships__in=self._content_relationships())\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n content_removed_and_readded = repo_relations.filter(\n version_removed=self, content_id__in=content_added\n ).values_list(\"content_id\")\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n repository = self.repository.cast()\n repository.initialize_new_version(self)\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.TextField(choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types added, removed, or present in the RepositoryVersion.\n\n For each content type present in or removed from this RepositoryVersion, create the URL of\n the viewset of that variety of content along with a query parameter which filters it by\n presence in this RepositoryVersion summary.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n repository_model = Repository.get_model_for_pulp_type(\n self.repository_version.repository.pulp_type\n )\n ctypes = {c.get_pulp_type(): c for c in repository_model.CONTENT_TYPES}\n ctype_model = ctypes[self.content_type]\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n kwargs = {}\n if settings.DOMAIN_ENABLED:\n kwargs[\"pulp_domain\"] = get_domain().name\n try:\n ctype_url = reverse(ctype_view, kwargs=kwargs)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n\n repository_view = get_view_name_for_model(repository_model, \"list\")\n\n repository_url = reverse(repository_view, kwargs=kwargs)\n rv_href = (\n repository_url\n + str(self.repository_version.repository_id)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.contrib.postgres.fields import HStoreField\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import F, Func, Q, Value\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import (\n batch_qs,\n get_url,\n get_view_name_for_model,\n get_domain,\n get_domain_pk,\n cache_key,\n)\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n pulp_labels (HStoreField): Dictionary of string values.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n pulp_domain (models.ForeignKeyField): The domain the Repository is a part of.\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n class Meta:\n unique_together = (\"name\", \"pulp_domain\")\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n # lock the repository if it was created from within a running task\n task_id = Task.current_id()\n if task_id is None:\n return\n\n repository_url = Value(get_url(self))\n update_func = Func(\n F(\"reserved_resources_record\"), repository_url, function=\"ARRAY_APPEND\"\n )\n updated = Task.objects.filter(pk=task_id).update(\n reserved_resources_record=update_func\n )\n if not updated:\n raise RuntimeError(f\"The repository '{self.name}' could not be locked\")\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def initialize_new_version(self, new_version):\n \"\"\"\n Initialize the new RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before any other\n actions performed on the new `RepositoryVersion`.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n \"\"\"\n pass\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n \"Deleting repository version {} due to version retention limit.\".format(version)\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self, everything=False):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if everything:\n from .publication import Distribution, Publication\n\n versions = self.versions.all()\n pubs = Publication.objects.filter(repository_version__in=versions, complete=True)\n distributions \|= Distribution.objects.filter(publication__in=pubs)\n distributions \|= Distribution.objects.filter(repository_version__in=versions)\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n pulp_labels (HStoreField): Dictionary of string values.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits requests per second for each concurrent downloader\n\n Relations:\n\n pulp_domain (models.ForeignKey): The domain the Remote is a part of.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, download_factory=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n download_factory (:class:`~pulpcore.plugin.download.DownloadFactory`): The download\n factory to be used.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n if download_factory is None:\n download_factory = self.download_factory\n return download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None, request=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from relative path and request.\n\n This method returns the URL for a RemoteArtifact by concatenating the Remote's url and the\n relative path. Plugin writers are expected to override this method when a more complex\n algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n request (aiohttp.web.Request): The request object for this relative path\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method. This method can return None if the\n relative path is for metadata that should only be streamed from the remote and not saved.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Optional[Class]: The optional Class of the content type that should be available at the\n relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n\n class Meta:\n default_related_name = \"remotes\"\n unique_together = (\"name\", \"pulp_domain\")\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n # Content can only be removed once it's no longer referenced by any repository\n content = models.ForeignKey(\n \"Content\", on_delete=models.PROTECT, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n # version_added and version_removed need to be properly handled in _squash before the version\n # can be deleted\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.RESTRICT\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\",\n null=True,\n related_name=\"removed_memberships\",\n on_delete=models.RESTRICT,\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n info = models.JSONField(default=dict)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository_id=self.repository_id, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(pk__in=self._content_relationships().values_list(\"content_id\"))\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n content_removed_and_readded = repo_relations.filter(\n version_removed=self, content_id__in=content_added\n ).values_list(\"content_id\")\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n repository = self.repository.cast()\n repository.initialize_new_version(self)\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.TextField(choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types added, removed, or present in the RepositoryVersion.\n\n For each content type present in or removed from this RepositoryVersion, create the URL of\n the viewset of that variety of content along with a query parameter which filters it by\n presence in this RepositoryVersion summary.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n repository_model = Repository.get_model_for_pulp_type(\n self.repository_version.repository.pulp_type\n )\n ctypes = {c.get_pulp_type(): c for c in repository_model.CONTENT_TYPES}\n ctype_model = ctypes[self.content_type]\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n kwargs = {}\n if settings.DOMAIN_ENABLED:\n kwargs[\"pulp_domain\"] = get_domain().name\n try:\n ctype_url = reverse(ctype_view, kwargs=kwargs)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n\n repository_view = get_view_name_for_model(repository_model, \"list\")\n\n repository_url = reverse(repository_view, kwargs=kwargs)\n rv_href = (\n repository_url\n + str(self.repository_version.repository_id)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix new file mode 100644 index 0000000000..c283c14070 --- /dev/null +++ b/CHANGES/3969.bugfix @@ -0,0 +1 @@ +Improved the performance when looking up content for repository versions. diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py index 921a316803..9f7bdaa068 100644 --- a/pulpcore/app/models/repository.py +++ b/pulpcore/app/models/repository.py @@ -692,7 +692,7 @@ def get_content(self, content_qs=None): if content_qs is None: content_qs = Content.objects - return content_qs.filter(version_memberships__in=self._content_relationships()) + return content_qs.filter(pk__in=self._content_relationships().values_list("content_id")) @property def content(self):
pulp__pulpcore-4275	Querying content in repository versions with lots of content is slow Version All Describe the bug When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, however I have notice queries that can take anywhere from 200ms to 1000ms. This appears to be due to the complex joins that have to be made on version_added and version_removed. To Reproduce - Load up a repository with a lot of content - Perform a query to fetch the last 100 objects or count how many objects are in it - Observe query speeds that would make sonic the hedgehog faint Expected behavior Database queries should be fast. Hopefully less than 50ms for complex ones, ideally lower than that. Some possible solutions - Adding the repo version numbers directly to the RepositoryContent table speeds up queries greatly. My testing showed that this can lower the queryset speed to 80ms with 65k content in some cases. - pulp_ansible is experimenting with querying the repository version table to look up RepositoryContent (https://github.com/pulp/pulp_ansible/blob/main/pulp_ansible/app/utils.py#L5). Results have been mixed with this. In some cases the query efficiency is substantially higher (on the order of 8x improvement). In other cases, it's roughly the same. - Some form of memoization/caching of querysets.	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.contrib.postgres.fields import HStoreField\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import F, Func, Q, Value\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import (\n batch_qs,\n get_url,\n get_view_name_for_model,\n get_domain,\n get_domain_pk,\n cache_key,\n)\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n pulp_labels (HStoreField): Dictionary of string values.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n pulp_domain (models.ForeignKeyField): The domain the Repository is a part of.\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n class Meta:\n unique_together = (\"name\", \"pulp_domain\")\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n # lock the repository if it was created from within a running task\n task_id = Task.current_id()\n if task_id is None:\n return\n\n repository_url = Value(get_url(self))\n update_func = Func(\n F(\"reserved_resources_record\"), repository_url, function=\"ARRAY_APPEND\"\n )\n updated = Task.objects.filter(pk=task_id).update(\n reserved_resources_record=update_func\n )\n if not updated:\n raise RuntimeError(f\"The repository '{self.name}' could not be locked\")\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def initialize_new_version(self, new_version):\n \"\"\"\n Initialize the new RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before any other\n actions performed on the new `RepositoryVersion`.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n \"\"\"\n pass\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n async def alatest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository asynchronously\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = await self.versions.complete().alatest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n \"Deleting repository version {} due to version retention limit.\".format(version)\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self, everything=False):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if everything:\n from .publication import Distribution, Publication\n\n versions = self.versions.all()\n pubs = Publication.objects.filter(repository_version__in=versions, complete=True)\n distributions \|= Distribution.objects.filter(publication__in=pubs)\n distributions \|= Distribution.objects.filter(repository_version__in=versions)\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n pulp_labels (HStoreField): Dictionary of string values.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits requests per second for each concurrent downloader\n\n Relations:\n\n pulp_domain (models.ForeignKey): The domain the Remote is a part of.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, download_factory=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n download_factory (:class:`~pulpcore.plugin.download.DownloadFactory`): The download\n factory to be used.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n if download_factory is None:\n download_factory = self.download_factory\n return download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None, request=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from relative path and request.\n\n This method returns the URL for a RemoteArtifact by concatenating the Remote's url and the\n relative path. Plugin writers are expected to override this method when a more complex\n algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n request (aiohttp.web.Request): The request object for this relative path\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method. This method can return None if the\n relative path is for metadata that should only be streamed from the remote and not saved.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Optional[Class]: The optional Class of the content type that should be available at the\n relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n\n class Meta:\n default_related_name = \"remotes\"\n unique_together = (\"name\", \"pulp_domain\")\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n # Content can only be removed once it's no longer referenced by any repository\n content = models.ForeignKey(\n \"Content\", on_delete=models.PROTECT, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n # version_added and version_removed need to be properly handled in _squash before the version\n # can be deleted\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.RESTRICT\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\",\n null=True,\n related_name=\"removed_memberships\",\n on_delete=models.RESTRICT,\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n info = models.JSONField(default=dict)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository_id=self.repository_id, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(version_memberships__in=self._content_relationships())\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n content_removed_and_readded = repo_relations.filter(\n version_removed=self, content_id__in=content_added\n ).values_list(\"content_id\")\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n repository = self.repository.cast()\n repository.initialize_new_version(self)\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.TextField(choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types added, removed, or present in the RepositoryVersion.\n\n For each content type present in or removed from this RepositoryVersion, create the URL of\n the viewset of that variety of content along with a query parameter which filters it by\n presence in this RepositoryVersion summary.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n repository_model = Repository.get_model_for_pulp_type(\n self.repository_version.repository.pulp_type\n )\n ctypes = {c.get_pulp_type(): c for c in repository_model.CONTENT_TYPES}\n ctype_model = ctypes[self.content_type]\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n kwargs = {}\n if settings.DOMAIN_ENABLED:\n kwargs[\"pulp_domain\"] = get_domain().name\n try:\n ctype_url = reverse(ctype_view, kwargs=kwargs)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n\n repository_view = get_view_name_for_model(repository_model, \"list\")\n\n repository_url = reverse(repository_view, kwargs=kwargs)\n rv_href = (\n repository_url\n + str(self.repository_version.repository_id)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom django.conf import settings\nfrom django.contrib.postgres.fields import HStoreField\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import F, Func, Q, Value\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import (\n batch_qs,\n get_url,\n get_view_name_for_model,\n get_domain,\n get_domain_pk,\n cache_key,\n)\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n pulp_labels (HStoreField): Dictionary of string values.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n pulp_domain (models.ForeignKeyField): The domain the Repository is a part of.\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n class Meta:\n unique_together = (\"name\", \"pulp_domain\")\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n # lock the repository if it was created from within a running task\n task_id = Task.current_id()\n if task_id is None:\n return\n\n repository_url = Value(get_url(self))\n update_func = Func(\n F(\"reserved_resources_record\"), repository_url, function=\"ARRAY_APPEND\"\n )\n updated = Task.objects.filter(pk=task_id).update(\n reserved_resources_record=update_func\n )\n if not updated:\n raise RuntimeError(f\"The repository '{self.name}' could not be locked\")\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def initialize_new_version(self, new_version):\n \"\"\"\n Initialize the new RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before any other\n actions performed on the new `RepositoryVersion`.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n \"\"\"\n pass\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n async def alatest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository asynchronously\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = await self.versions.complete().alatest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n \"Deleting repository version {} due to version retention limit.\".format(version)\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self, everything=False):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if everything:\n from .publication import Distribution, Publication\n\n versions = self.versions.all()\n pubs = Publication.objects.filter(repository_version__in=versions, complete=True)\n distributions \|= Distribution.objects.filter(publication__in=pubs)\n distributions \|= Distribution.objects.filter(repository_version__in=versions)\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n pulp_labels (HStoreField): Dictionary of string values.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits requests per second for each concurrent downloader\n\n Relations:\n\n pulp_domain (models.ForeignKey): The domain the Remote is a part of.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True)\n pulp_labels = HStoreField(default=dict)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n pulp_domain = models.ForeignKey(\"Domain\", default=get_domain_pk, on_delete=models.PROTECT)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, download_factory=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n download_factory (:class:`~pulpcore.plugin.download.DownloadFactory`): The download\n factory to be used.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n if download_factory is None:\n download_factory = self.download_factory\n return download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None, request=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from relative path and request.\n\n This method returns the URL for a RemoteArtifact by concatenating the Remote's url and the\n relative path. Plugin writers are expected to override this method when a more complex\n algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n request (aiohttp.web.Request): The request object for this relative path\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method. This method can return None if the\n relative path is for metadata that should only be streamed from the remote and not saved.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Optional[Class]: The optional Class of the content type that should be available at the\n relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=cache_key(base_paths))\n\n class Meta:\n default_related_name = \"remotes\"\n unique_together = (\"name\", \"pulp_domain\")\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n # Content can only be removed once it's no longer referenced by any repository\n content = models.ForeignKey(\n \"Content\", on_delete=models.PROTECT, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n # version_added and version_removed need to be properly handled in _squash before the version\n # can be deleted\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.RESTRICT\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\",\n null=True,\n related_name=\"removed_memberships\",\n on_delete=models.RESTRICT,\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n info = models.JSONField(default=dict)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository_id=self.repository_id, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(pk__in=self._content_relationships().values_list(\"content_id\"))\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n content_removed_and_readded = repo_relations.filter(\n version_removed=self, content_id__in=content_added\n ).values_list(\"content_id\")\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n repository = self.repository.cast()\n repository.initialize_new_version(self)\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.TextField(choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types added, removed, or present in the RepositoryVersion.\n\n For each content type present in or removed from this RepositoryVersion, create the URL of\n the viewset of that variety of content along with a query parameter which filters it by\n presence in this RepositoryVersion summary.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n repository_model = Repository.get_model_for_pulp_type(\n self.repository_version.repository.pulp_type\n )\n ctypes = {c.get_pulp_type(): c for c in repository_model.CONTENT_TYPES}\n ctype_model = ctypes[self.content_type]\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n kwargs = {}\n if settings.DOMAIN_ENABLED:\n kwargs[\"pulp_domain\"] = get_domain().name\n try:\n ctype_url = reverse(ctype_view, kwargs=kwargs)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n\n repository_view = get_view_name_for_model(repository_model, \"list\")\n\n repository_url = reverse(repository_view, kwargs=kwargs)\n rv_href = (\n repository_url\n + str(self.repository_version.repository_id)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix new file mode 100644 index 0000000000..c283c14070 --- /dev/null +++ b/CHANGES/3969.bugfix @@ -0,0 +1 @@ +Improved the performance when looking up content for repository versions. diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py index 5b84532c99..a73bfaac93 100644 --- a/pulpcore/app/models/repository.py +++ b/pulpcore/app/models/repository.py @@ -707,7 +707,7 @@ def get_content(self, content_qs=None): if content_qs is None: content_qs = Content.objects - return content_qs.filter(version_memberships__in=self._content_relationships()) + return content_qs.filter(pk__in=self._content_relationships().values_list("content_id")) @property def content(self):
rucio__rucio-6440	gfal RSE protocol ignores the verify_checksum attribute The protocol raises an exception even if the attribute is set to false: https://github.com/rucio/rucio/blob/436ecc9005934e1e4332cd2718d160bdbf5105d2/lib/rucio/rse/protocols/gfal.py#L413	[ { "content": "# -- coding: utf-8 --\n# Copyright European Organization for Nuclear Research (CERN) since 2012\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport errno\nimport json\nimport logging\nimport os\nimport re\nimport subprocess\nimport urllib.parse as urlparse\nfrom threading import Timer\n\nfrom rucio.common import exception, config\nfrom rucio.common.constraints import STRING_TYPES\nfrom rucio.common.utils import GLOBALLY_SUPPORTED_CHECKSUMS, PREFERRED_CHECKSUM\nfrom rucio.rse.protocols import protocol\n\ntry:\n import gfal2 # pylint: disable=import-error\nexcept:\n if 'RUCIO_CLIENT_MODE' not in os.environ:\n if not config.config_has_section('database'):\n raise exception.MissingDependency('Missing dependency : gfal2')\n else:\n if os.environ['RUCIO_CLIENT_MODE']:\n raise exception.MissingDependency('Missing dependency : gfal2')\n\nTIMEOUT = config.config_get('deletion', 'timeout', False, None)\n\n\nclass Default(protocol.RSEProtocol):\n \"\"\" Implementing access to RSEs using the srm protocol.\"\"\"\n\n def lfns2pfns(self, lfns):\n \"\"\"\n Returns a fully qualified PFN for the file referred by path.\n\n :param path: The path to the file.\n\n :returns: Fully qualified PFN.\n \"\"\"\n lfns = [lfns] if isinstance(lfns, dict) else lfns\n\n pfns = {}\n prefix = self.attributes['prefix']\n if self.attributes['extended_attributes'] is not None and 'web_service_path' in list(self.attributes['extended_attributes'].keys()):\n web_service_path = self.attributes['extended_attributes']['web_service_path']\n else:\n web_service_path = ''\n\n if not prefix.startswith('/'):\n prefix = ''.join(['/', prefix])\n if not prefix.endswith('/'):\n prefix = ''.join([prefix, '/'])\n\n hostname = self.attributes['hostname']\n if '://' in hostname:\n hostname = hostname.split(\"://\")[1]\n\n if self.attributes['port'] == 0:\n for lfn in lfns:\n scope, name = str(lfn['scope']), lfn['name']\n path = lfn['path'] if 'path' in lfn and lfn['path'] else self._get_path(scope=scope, name=name)\n if self.attributes['scheme'] != 'root' and path.startswith('/'): # do not modify path if it is root\n path = path[1:]\n pfns['%s:%s' % (scope, name)] = ''.join([self.attributes['scheme'], '://', hostname, web_service_path, prefix, path])\n else:\n for lfn in lfns:\n scope, name = str(lfn['scope']), lfn['name']\n path = lfn['path'] if 'path' in lfn and lfn['path'] else self._get_path(scope=scope, name=name)\n if self.attributes['scheme'] != 'root' and path.startswith('/'): # do not modify path if it is root\n path = path[1:]\n if re.match(r'^\\w+://', path): # This is already a URL\n pfns['%s:%s' % (scope, name)] = path\n else:\n pfns['%s:%s' % (scope, name)] = ''.join([self.attributes['scheme'], '://', hostname, ':', str(self.attributes['port']), web_service_path, prefix, path])\n\n return pfns\n\n def parse_pfns(self, pfns):\n \"\"\"\n Splits the given PFN into the parts known by the protocol. During parsing the PFN is also checked for\n validity on the given RSE with the given protocol.\n\n :param pfn: a fully qualified PFN\n\n :returns: a dict containing all known parts of the PFN for the protocol e.g. scheme, path, filename\n\n :raises RSEFileNameNotSupported: if the provided PFN doesn't match with the protocol settings\n \"\"\"\n\n self.logger(logging.DEBUG, 'parsing {} pfns'.format(len(list(pfns))))\n ret = dict()\n pfns = [pfns] if isinstance(pfns, STRING_TYPES) else pfns\n for pfn in pfns:\n parsed = urlparse.urlparse(pfn)\n if parsed.path.startswith('/srm/managerv2') or parsed.path.startswith('/srm/managerv1') or parsed.path.startswith('/srm/v2/server'):\n scheme, hostname, port, service_path, path = re.findall(r\"([^:]+)://([^:/]+):?(\\d+)?([^:]+=)?([^:]+)\", pfn)[0]\n else:\n scheme = parsed.scheme\n hostname = parsed.netloc.partition(':')[0]\n port = parsed.netloc.partition(':')[2]\n path = parsed.path\n service_path = ''\n\n if self.attributes['hostname'] != hostname and self.attributes['hostname'] != scheme + \"://\" + hostname:\n raise exception.RSEFileNameNotSupported('Invalid hostname: provided \\'%s\\', expected \\'%s\\'' % (hostname, self.attributes['hostname']))\n\n if port != '' and str(self.attributes['port']) != str(port):\n raise exception.RSEFileNameNotSupported('Invalid port: provided \\'%s\\', expected \\'%s\\'' % (port, self.attributes['port']))\n elif port == '':\n port = self.attributes['port']\n\n if not path.startswith(self.attributes['prefix']):\n raise exception.RSEFileNameNotSupported('Invalid prefix: provided \\'%s\\', expected \\'%s\\'' % ('/'.join(path.split('/')[0:len(self.attributes['prefix'].split('/')) - 1]),\n self.attributes['prefix'])) # len(...)-1 due to the leading '/\n # Spliting path into prefix, path, filename\n prefix = self.attributes['prefix']\n path = path.partition(self.attributes['prefix'])[2]\n name = path.split('/')[-1]\n path = '/'.join(path.split('/')[:-1])\n if not path.startswith('/'):\n path = '/' + path\n if path != '/' and not path.endswith('/'):\n path = path + '/'\n ret[pfn] = {'scheme': scheme, 'port': port, 'hostname': hostname, 'path': path, 'name': name, 'prefix': prefix, 'web_service_path': service_path}\n\n return ret\n\n def path2pfn(self, path):\n \"\"\"\n Returns a fully qualified PFN for the file referred by path.\n\n :param path: The path to the file.\n\n :returns: Fully qualified PFN.\n \"\"\"\n self.logger(logging.DEBUG, 'getting pfn for {}'.format(path))\n\n if '://' in path:\n return path\n\n hostname = self.attributes['hostname']\n if '://' in hostname:\n hostname = hostname.split(\"://\")[1]\n\n if 'extended_attributes' in list(self.attributes.keys()) and self.attributes['extended_attributes'] is not None and 'web_service_path' in list(self.attributes['extended_attributes'].keys()):\n web_service_path = self.attributes['extended_attributes']['web_service_path']\n else:\n web_service_path = ''\n\n if not path.startswith('srm'):\n if self.attributes['port'] > 0:\n return ''.join([self.attributes['scheme'], '://', hostname, ':', str(self.attributes['port']), web_service_path, path])\n else:\n return ''.join([self.attributes['scheme'], '://', hostname, web_service_path, path])\n else:\n return path\n\n def connect(self):\n \"\"\"\n Establishes the actual connection to the referred RSE.\n If we decide to use gfal, init should be done here.\n\n :raises RSEAccessDenied\n \"\"\"\n self.logger(logging.DEBUG, 'connecting to storage')\n\n if 'RUCIO_CLIENT_MODE' in os.environ:\n gfal2.set_verbose(gfal2.verbose_level.verbose)\n else:\n gfal2.set_verbose(gfal2.verbose_level.warning)\n\n self.__ctx = gfal2.creat_context() # pylint: disable=no-member\n self.__ctx.set_opt_string_list(\"SRM PLUGIN\", \"TURL_PROTOCOLS\", [\"gsiftp\", \"rfio\", \"gsidcap\", \"dcap\", \"kdcap\"])\n self.__ctx.set_opt_string(\"XROOTD PLUGIN\", \"XRD.WANTPROT\", \"gsi,unix\")\n self.__ctx.set_opt_boolean(\"XROOTD PLUGIN\", \"NORMALIZE_PATH\", False)\n auth_configured = False\n if self.auth_token:\n self.__ctx.set_opt_string(\"BEARER\", \"TOKEN\", self.auth_token)\n auth_configured = True\n # Configure gfal authentication to use the rucio client proxy if and only if gfal didn't initialize its credentials already\n # (https://gitlab.cern.ch/dmc/gfal2/-/blob/48cfe3476392c884b53d00799198b1238603a406/src/core/common/gfal_common.c#L79)\n if not auth_configured:\n try:\n self.__ctx.get_opt_string(\"X509\", \"CERT\")\n self.__ctx.get_opt_string(\"X509\", \"KEY\")\n auth_configured = True\n except gfal2.GError: # pylint: disable=no-member\n pass\n if not auth_configured:\n try:\n self.__ctx.get_opt_string(\"BEARER\", \"TOKEN\")\n auth_configured = True\n except gfal2.GError: # pylint: disable=no-member\n pass\n if not auth_configured:\n proxy = config.config_get('client', 'client_x509_proxy', default=None, raise_exception=False)\n if proxy:\n self.logger(logging.INFO, 'Configuring authentication to use {}'.format(proxy))\n self.__ctx.set_opt_string(\"X509\", \"CERT\", proxy)\n self.__ctx.set_opt_string(\"X509\", \"KEY\", proxy)\n\n if TIMEOUT:\n try:\n timeout = int(TIMEOUT)\n self.__ctx.set_opt_integer(\"HTTP PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n self.__ctx.set_opt_integer(\"SRM PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n self.__ctx.set_opt_integer(\"GRIDFTP PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n except ValueError:\n self.logger(logging.ERROR, 'wrong timeout value %s', TIMEOUT)\n\n def get(self, path, dest, transfer_timeout=None):\n \"\"\"\n Provides access to files stored inside connected the RSE.\n\n :param path: Physical file name of requested file\n :param dest: Name and path of the files when stored at the client\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'downloading file from {} to {}'.format(path, dest))\n\n dest = os.path.abspath(dest)\n if ':' not in dest:\n dest = \"file://\" + dest\n\n try:\n status = self.__gfal2_copy(path, dest, transfer_timeout=transfer_timeout)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def put(self, source, target, source_dir, transfer_timeout=None):\n \"\"\"\n Allows to store files inside the referred RSE.\n\n :param source: path to the source file on the client file system\n :param target: path to the destination file on the storage\n :param source_dir: Path where the to be transferred files are stored in the local file system\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'uploading file from {} to {}'.format(source, target))\n\n source_url = '%s/%s' % (source_dir, source) if source_dir else source\n source_url = os.path.abspath(source_url)\n if not os.path.exists(source_url):\n raise exception.SourceNotFound()\n if ':' not in source_url:\n source_url = \"file://\" + source_url\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n\n try:\n status = self.__gfal2_copy(str(source_url), str(target), None, space_token, transfer_timeout=transfer_timeout)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.DestinationNotAccessible(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def delete(self, path):\n \"\"\"\n Deletes a file from the connected RSE.\n\n :param path: path to the to be deleted file\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'deleting file {}'.format(path))\n\n pfns = [path] if isinstance(path, STRING_TYPES) else path\n\n try:\n status = self.__gfal2_rm(pfns)\n if status:\n raise exception.RucioException()\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def rename(self, path, new_path):\n \"\"\"\n Allows to rename a file stored inside the connected RSE.\n\n :param path: path to the current file on the storage\n :param new_path: path to the new file on the storage\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'renaming file from {} to {}'.format(path, new_path))\n\n try:\n status = self.__gfal2_rename(path, new_path)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def exists(self, path):\n \"\"\"\n Checks if the requested file is known by the referred RSE.\n\n :param path: Physical file name\n\n :returns: True if the file exists, False if it doesn't\n\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'checking if file exists {}'.format(path))\n\n try:\n status = self.__gfal2_exist(path)\n if status:\n return False\n return True\n except exception.SourceNotFound:\n return False\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def close(self):\n \"\"\"\n Closes the connection to RSE.\n \"\"\"\n self.logger(logging.DEBUG, 'closing protocol connection')\n del self.__ctx\n self.__ctx = None\n\n def stat(self, path):\n \"\"\"\n Returns the stats of a file.\n\n :param path: path to file\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n\n :returns: a dict with two keys, filesize and an element of GLOBALLY_SUPPORTED_CHECKSUMS.\n \"\"\"\n self.logger(logging.DEBUG, 'getting stats of file {}'.format(path))\n\n ret = {}\n ctx = self.__ctx\n\n path = str(path)\n\n try:\n stat_str = str(ctx.stat(path))\n except Exception as error:\n msg = 'Error while processing gfal stat call. Error: %s'\n raise exception.ServiceUnavailable(msg % str(error))\n\n stats = stat_str.split()\n if len(stats) < 8:\n msg = 'gfal stat call result has unknown format. Result: %s'\n raise exception.ServiceUnavailable(msg % stat_str)\n\n ret['filesize'] = stats[7]\n\n message = \"\\n\"\n try:\n ret[PREFERRED_CHECKSUM] = ctx.checksum(path, str(PREFERRED_CHECKSUM.upper()))\n return ret\n except Exception as error:\n message += 'Error while processing gfal checksum call (%s). Error: %s \\n' % (PREFERRED_CHECKSUM, str(error))\n\n for checksum_name in GLOBALLY_SUPPORTED_CHECKSUMS:\n if checksum_name == PREFERRED_CHECKSUM:\n continue\n try:\n ret[checksum_name] = ctx.checksum(path, str(checksum_name.upper()))\n return ret\n except Exception as error:\n message += 'Error while processing gfal checksum call (%s). Error: %s \\n' % (checksum_name, str(error))\n\n raise exception.RSEChecksumUnavailable(message)\n\n def __gfal2_cancel(self):\n \"\"\"\n Cancel all gfal operations in progress.\n \"\"\"\n self.logger(logging.DEBUG, 'gfal: cancelling all operations')\n\n ctx = self.__ctx\n if ctx:\n ctx.cancel()\n\n def __gfal2_copy(self, src, dest, src_spacetoken=None, dest_spacetoken=None, transfer_timeout=None):\n \"\"\"\n Uses gfal2 to copy file from src to dest.\n\n :param src: Physical source file name\n :param src_spacetoken: The source file's space token\n :param dest: Physical destination file name\n :param dest_spacetoken: The destination file's space token\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :returns: 0 if copied successfully, other than 0 if failed\n\n :raises SourceNotFound: if source file cannot be found.\n :raises RucioException: if it failed to copy the file.\n \"\"\"\n ctx = self.__ctx\n if transfer_timeout:\n ctx.set_opt_integer(\"HTTP PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n ctx.set_opt_integer(\"SRM PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n ctx.set_opt_integer(\"GRIDFTP PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n watchdog = Timer(int(transfer_timeout) + 60, self.__gfal2_cancel)\n params = ctx.transfer_parameters()\n if src_spacetoken:\n params.src_spacetoken = str(src_spacetoken)\n if dest_spacetoken:\n params.dst_spacetoken = str(dest_spacetoken)\n\n if not (self.renaming and dest.startswith('https')):\n params.create_parent = True\n\n if not self.renaming:\n params.strict_copy = True\n\n try:\n if transfer_timeout:\n params.timeout = int(transfer_timeout)\n watchdog.start()\n ret = ctx.filecopy(params, str(src), str(dest))\n if transfer_timeout:\n watchdog.cancel()\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if transfer_timeout:\n watchdog.cancel()\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def __gfal2_rm(self, paths):\n \"\"\"\n Uses gfal2 to remove the file.\n\n :param path: Physical file name\n\n :returns: 0 if removed successfully, other than 0 if failed\n\n :raises SourceNotFound: if the source file was not found.\n :raises RucioException: if it failed to remove the file.\n \"\"\"\n\n ctx = self.__ctx\n\n try:\n for path in paths:\n if self.__gfal2_exist(path) == 0:\n ret = ctx.unlink(str(path))\n if ret:\n return ret\n else:\n raise exception.SourceNotFound\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def __gfal2_exist(self, path):\n \"\"\"\n Uses gfal2 to check whether the file exists.\n\n :param path: Physical file name\n\n :returns: 0 if it exists, -1 if it doesn't\n\n :raises RucioException: if the error is not source not found.\n \"\"\"\n ctx = self.__ctx\n try:\n if ctx.stat(str(path)):\n return 0\n return -1\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error): # pylint: disable=no-member\n return -1\n raise exception.RucioException(error)\n\n def __gfal2_rename(self, path, new_path):\n \"\"\"\n Uses gfal2 to rename a file.\n\n :param path: path to the current file on the storage\n :param new_path: path to the new file on the storage\n\n :returns: 0 if it exists, -1 if it doesn't\n\n :raises RucioException: if failed.\n \"\"\"\n ctx = self.__ctx\n\n try:\n dir_name = os.path.dirname(new_path)\n # This function will be removed soon. gfal2 will create parent dir automatically.\n try:\n ctx.mkdir_rec(str(dir_name), 0o775)\n except Exception:\n pass\n ret = ctx.rename(str(path), str(new_path))\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def get_space_usage(self):\n \"\"\"\n Get RSE space usage information.\n\n :returns: a list with dict containing 'totalsize' and 'unusedsize'\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n \"\"\"\n endpoint_basepath = self.path2pfn(self.attributes['prefix'])\n self.logger(logging.DEBUG, 'getting space usage from {}'.format(endpoint_basepath))\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n\n if space_token is None or space_token == \"\":\n raise exception.RucioException(\"Space token is not defined for protocol: %s\" % (self.attributes['scheme']))\n\n try:\n totalsize, unusedsize = self.__gfal2_get_space_usage(endpoint_basepath, space_token)\n return totalsize, unusedsize\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def __gfal2_get_space_usage(self, path, space_token):\n \"\"\"\n Uses gfal2 to get space usage info with space token.\n\n :param path: the endpoint path\n :param space_token: a string space token. E.g. \"ATLASDATADISK\"\n\n :returns: a list with dict containing 'totalsize' and 'unusedsize'\n\n :raises ServiceUnavailable: if failed.\n \"\"\"\n ctx = self.__ctx\n\n try:\n ret_usage = ctx.getxattr(str(path), str(\"spacetoken.description?\" + space_token))\n usage = json.loads(ret_usage)\n totalsize = usage[0][\"totalsize\"]\n unusedsize = usage[0][\"unusedsize\"]\n return totalsize, unusedsize\n except gfal2.GError as error: # pylint: disable=no-member\n raise Exception(str(error))\n\n\nclass NoRename(Default):\n\n \"\"\" Implementing access to RSEs using the srm protocol without renaming files on upload/download. Necessary for some storage endpoints. \"\"\"\n\n def __init__(self, protocol_attr, rse_settings, logger=logging.log):\n \"\"\" Initializes the object with information about the referred RSE.\n\n :param protocol_attr: Properties of the requested protocol.\n :param rse_settting: The RSE settings.\n :param logger: Optional decorated logger that can be passed from the calling daemons or servers.\n \"\"\"\n super(NoRename, self).__init__(protocol_attr, rse_settings, logger=logger)\n self.renaming = False\n self.attributes.pop('determinism_type', None)\n self.files = []\n\n def rename(self, pfn, new_pfn):\n \"\"\" Allows to rename a file stored inside the connected RSE.\n\n :param pfn: Current physical file name\n :param new_pfn New physical file name\n\n :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound\n \"\"\"\n raise NotImplementedError\n\n\nclass CLI(Default):\n\n \"\"\" Implementing access to RSEs using the srm protocol through CLI with 'gfal' commands. \"\"\"\n\n def __init__(self, protocol_attr, rse_settings, logger=logging.log):\n \"\"\" Initializes the object with information about the referred RSE.\n\n :param props: Properties derived from the RSE Repository\n \"\"\"\n\n super(CLI, self).__init__(protocol_attr, rse_settings, logger=logger)\n if not logger:\n logger = logging.getLogger('%s.null' % __name__)\n self.logger = logger\n\n def get(self, path, dest, transfer_timeout=None):\n \"\"\"\n Provides access to files stored inside connected the RSE.\n\n :param path: Physical file name of requested file\n :param dest: Name and path of the files when stored at the client\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises RucioException: Passthrough of gfal-copy error message.\n \"\"\"\n\n dest = os.path.abspath(dest)\n if ':' not in dest:\n dest = \"file://\" + dest\n\n cmd = 'gfal-copy -vf -p -t %s -T %s %s %s' % (transfer_timeout, transfer_timeout, path, dest)\n self.logger(logging.DEBUG, 'Command: ' + cmd)\n cmd = cmd.split()\n\n p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n stdout, stderr = p.communicate()\n\n if p.returncode:\n self.logger(logging.DEBUG, 'Error STDOUT: ' + str(stdout))\n self.logger(logging.DEBUG, 'Error STDERR: ' + str(stderr))\n raise exception.RucioException(str(stderr))\n\n def put(self, source, target, source_dir, transfer_timeout=None):\n \"\"\"\n Allows to store files inside the referred RSE.\n\n :param source: path to the source file on the client file system\n :param target: path to the destination file on the storage\n :param source_dir: Path where the to be transferred files are stored in the local file system\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises RucioException: Passthrough of gfal-copy error message.\n \"\"\"\n\n source_dir = source_dir or '.'\n source_url = '%s/%s' % (source_dir, source)\n self.logger(logging.DEBUG, 'source: ' + str(source_url))\n source_url = os.path.abspath(source_url)\n if not os.path.exists(source_url):\n raise exception.SourceNotFound()\n if ':' not in source_url:\n source_url = \"file://\" + source_url\n\n cmd = 'gfal-copy -vf -p -t %s -T %s %s %s ' % (transfer_timeout, transfer_timeout, source, target)\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n cmd = 'gfal-copy -vf -p -t %s -T %s -S %s %s %s ' % (transfer_timeout, transfer_timeout, space_token, source, target)\n\n self.logger(logging.DEBUG, 'Command: ' + cmd)\n cmd = cmd.split()\n\n p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n stdout, stderr = p.communicate()\n\n if p.returncode:\n self.logger(logging.DEBUG, 'Error STDOUT: ' + str(stdout))\n self.logger(logging.DEBUG, 'Error STDERR: ' + str(stderr))\n raise exception.RucioException(str(stderr))\n", "path": "lib/rucio/rse/protocols/gfal.py" } ]	[ { "content": "# -- coding: utf-8 --\n# Copyright European Organization for Nuclear Research (CERN) since 2012\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\");\n# you may not use this file except in compliance with the License.\n# You may obtain a copy of the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS,\n# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n# See the License for the specific language governing permissions and\n# limitations under the License.\n\nimport errno\nimport json\nimport logging\nimport os\nimport re\nimport subprocess\nimport urllib.parse as urlparse\nfrom threading import Timer\n\nfrom rucio.common import exception, config\nfrom rucio.common.constraints import STRING_TYPES\nfrom rucio.common.utils import GLOBALLY_SUPPORTED_CHECKSUMS, PREFERRED_CHECKSUM\nfrom rucio.rse.protocols import protocol\n\ntry:\n import gfal2 # pylint: disable=import-error\nexcept:\n if 'RUCIO_CLIENT_MODE' not in os.environ:\n if not config.config_has_section('database'):\n raise exception.MissingDependency('Missing dependency : gfal2')\n else:\n if os.environ['RUCIO_CLIENT_MODE']:\n raise exception.MissingDependency('Missing dependency : gfal2')\n\nTIMEOUT = config.config_get('deletion', 'timeout', False, None)\n\n\nclass Default(protocol.RSEProtocol):\n \"\"\" Implementing access to RSEs using the srm protocol.\"\"\"\n\n def lfns2pfns(self, lfns):\n \"\"\"\n Returns a fully qualified PFN for the file referred by path.\n\n :param path: The path to the file.\n\n :returns: Fully qualified PFN.\n \"\"\"\n lfns = [lfns] if isinstance(lfns, dict) else lfns\n\n pfns = {}\n prefix = self.attributes['prefix']\n if self.attributes['extended_attributes'] is not None and 'web_service_path' in list(self.attributes['extended_attributes'].keys()):\n web_service_path = self.attributes['extended_attributes']['web_service_path']\n else:\n web_service_path = ''\n\n if not prefix.startswith('/'):\n prefix = ''.join(['/', prefix])\n if not prefix.endswith('/'):\n prefix = ''.join([prefix, '/'])\n\n hostname = self.attributes['hostname']\n if '://' in hostname:\n hostname = hostname.split(\"://\")[1]\n\n if self.attributes['port'] == 0:\n for lfn in lfns:\n scope, name = str(lfn['scope']), lfn['name']\n path = lfn['path'] if 'path' in lfn and lfn['path'] else self._get_path(scope=scope, name=name)\n if self.attributes['scheme'] != 'root' and path.startswith('/'): # do not modify path if it is root\n path = path[1:]\n pfns['%s:%s' % (scope, name)] = ''.join([self.attributes['scheme'], '://', hostname, web_service_path, prefix, path])\n else:\n for lfn in lfns:\n scope, name = str(lfn['scope']), lfn['name']\n path = lfn['path'] if 'path' in lfn and lfn['path'] else self._get_path(scope=scope, name=name)\n if self.attributes['scheme'] != 'root' and path.startswith('/'): # do not modify path if it is root\n path = path[1:]\n if re.match(r'^\\w+://', path): # This is already a URL\n pfns['%s:%s' % (scope, name)] = path\n else:\n pfns['%s:%s' % (scope, name)] = ''.join([self.attributes['scheme'], '://', hostname, ':', str(self.attributes['port']), web_service_path, prefix, path])\n\n return pfns\n\n def parse_pfns(self, pfns):\n \"\"\"\n Splits the given PFN into the parts known by the protocol. During parsing the PFN is also checked for\n validity on the given RSE with the given protocol.\n\n :param pfn: a fully qualified PFN\n\n :returns: a dict containing all known parts of the PFN for the protocol e.g. scheme, path, filename\n\n :raises RSEFileNameNotSupported: if the provided PFN doesn't match with the protocol settings\n \"\"\"\n\n self.logger(logging.DEBUG, 'parsing {} pfns'.format(len(list(pfns))))\n ret = dict()\n pfns = [pfns] if isinstance(pfns, STRING_TYPES) else pfns\n for pfn in pfns:\n parsed = urlparse.urlparse(pfn)\n if parsed.path.startswith('/srm/managerv2') or parsed.path.startswith('/srm/managerv1') or parsed.path.startswith('/srm/v2/server'):\n scheme, hostname, port, service_path, path = re.findall(r\"([^:]+)://([^:/]+):?(\\d+)?([^:]+=)?([^:]+)\", pfn)[0]\n else:\n scheme = parsed.scheme\n hostname = parsed.netloc.partition(':')[0]\n port = parsed.netloc.partition(':')[2]\n path = parsed.path\n service_path = ''\n\n if self.attributes['hostname'] != hostname and self.attributes['hostname'] != scheme + \"://\" + hostname:\n raise exception.RSEFileNameNotSupported('Invalid hostname: provided \\'%s\\', expected \\'%s\\'' % (hostname, self.attributes['hostname']))\n\n if port != '' and str(self.attributes['port']) != str(port):\n raise exception.RSEFileNameNotSupported('Invalid port: provided \\'%s\\', expected \\'%s\\'' % (port, self.attributes['port']))\n elif port == '':\n port = self.attributes['port']\n\n if not path.startswith(self.attributes['prefix']):\n raise exception.RSEFileNameNotSupported('Invalid prefix: provided \\'%s\\', expected \\'%s\\'' % ('/'.join(path.split('/')[0:len(self.attributes['prefix'].split('/')) - 1]),\n self.attributes['prefix'])) # len(...)-1 due to the leading '/\n # Spliting path into prefix, path, filename\n prefix = self.attributes['prefix']\n path = path.partition(self.attributes['prefix'])[2]\n name = path.split('/')[-1]\n path = '/'.join(path.split('/')[:-1])\n if not path.startswith('/'):\n path = '/' + path\n if path != '/' and not path.endswith('/'):\n path = path + '/'\n ret[pfn] = {'scheme': scheme, 'port': port, 'hostname': hostname, 'path': path, 'name': name, 'prefix': prefix, 'web_service_path': service_path}\n\n return ret\n\n def path2pfn(self, path):\n \"\"\"\n Returns a fully qualified PFN for the file referred by path.\n\n :param path: The path to the file.\n\n :returns: Fully qualified PFN.\n \"\"\"\n self.logger(logging.DEBUG, 'getting pfn for {}'.format(path))\n\n if '://' in path:\n return path\n\n hostname = self.attributes['hostname']\n if '://' in hostname:\n hostname = hostname.split(\"://\")[1]\n\n if 'extended_attributes' in list(self.attributes.keys()) and self.attributes['extended_attributes'] is not None and 'web_service_path' in list(self.attributes['extended_attributes'].keys()):\n web_service_path = self.attributes['extended_attributes']['web_service_path']\n else:\n web_service_path = ''\n\n if not path.startswith('srm'):\n if self.attributes['port'] > 0:\n return ''.join([self.attributes['scheme'], '://', hostname, ':', str(self.attributes['port']), web_service_path, path])\n else:\n return ''.join([self.attributes['scheme'], '://', hostname, web_service_path, path])\n else:\n return path\n\n def connect(self):\n \"\"\"\n Establishes the actual connection to the referred RSE.\n If we decide to use gfal, init should be done here.\n\n :raises RSEAccessDenied\n \"\"\"\n self.logger(logging.DEBUG, 'connecting to storage')\n\n if 'RUCIO_CLIENT_MODE' in os.environ:\n gfal2.set_verbose(gfal2.verbose_level.verbose)\n else:\n gfal2.set_verbose(gfal2.verbose_level.warning)\n\n self.__ctx = gfal2.creat_context() # pylint: disable=no-member\n self.__ctx.set_opt_string_list(\"SRM PLUGIN\", \"TURL_PROTOCOLS\", [\"gsiftp\", \"rfio\", \"gsidcap\", \"dcap\", \"kdcap\"])\n self.__ctx.set_opt_string(\"XROOTD PLUGIN\", \"XRD.WANTPROT\", \"gsi,unix\")\n self.__ctx.set_opt_boolean(\"XROOTD PLUGIN\", \"NORMALIZE_PATH\", False)\n auth_configured = False\n if self.auth_token:\n self.__ctx.set_opt_string(\"BEARER\", \"TOKEN\", self.auth_token)\n auth_configured = True\n # Configure gfal authentication to use the rucio client proxy if and only if gfal didn't initialize its credentials already\n # (https://gitlab.cern.ch/dmc/gfal2/-/blob/48cfe3476392c884b53d00799198b1238603a406/src/core/common/gfal_common.c#L79)\n if not auth_configured:\n try:\n self.__ctx.get_opt_string(\"X509\", \"CERT\")\n self.__ctx.get_opt_string(\"X509\", \"KEY\")\n auth_configured = True\n except gfal2.GError: # pylint: disable=no-member\n pass\n if not auth_configured:\n try:\n self.__ctx.get_opt_string(\"BEARER\", \"TOKEN\")\n auth_configured = True\n except gfal2.GError: # pylint: disable=no-member\n pass\n if not auth_configured:\n proxy = config.config_get('client', 'client_x509_proxy', default=None, raise_exception=False)\n if proxy:\n self.logger(logging.INFO, 'Configuring authentication to use {}'.format(proxy))\n self.__ctx.set_opt_string(\"X509\", \"CERT\", proxy)\n self.__ctx.set_opt_string(\"X509\", \"KEY\", proxy)\n\n if TIMEOUT:\n try:\n timeout = int(TIMEOUT)\n self.__ctx.set_opt_integer(\"HTTP PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n self.__ctx.set_opt_integer(\"SRM PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n self.__ctx.set_opt_integer(\"GRIDFTP PLUGIN\", \"OPERATION_TIMEOUT\", timeout)\n except ValueError:\n self.logger(logging.ERROR, 'wrong timeout value %s', TIMEOUT)\n\n def get(self, path, dest, transfer_timeout=None):\n \"\"\"\n Provides access to files stored inside connected the RSE.\n\n :param path: Physical file name of requested file\n :param dest: Name and path of the files when stored at the client\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'downloading file from {} to {}'.format(path, dest))\n\n dest = os.path.abspath(dest)\n if ':' not in dest:\n dest = \"file://\" + dest\n\n try:\n status = self.__gfal2_copy(path, dest, transfer_timeout=transfer_timeout)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def put(self, source, target, source_dir, transfer_timeout=None):\n \"\"\"\n Allows to store files inside the referred RSE.\n\n :param source: path to the source file on the client file system\n :param target: path to the destination file on the storage\n :param source_dir: Path where the to be transferred files are stored in the local file system\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'uploading file from {} to {}'.format(source, target))\n\n source_url = '%s/%s' % (source_dir, source) if source_dir else source\n source_url = os.path.abspath(source_url)\n if not os.path.exists(source_url):\n raise exception.SourceNotFound()\n if ':' not in source_url:\n source_url = \"file://\" + source_url\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n\n try:\n status = self.__gfal2_copy(str(source_url), str(target), None, space_token, transfer_timeout=transfer_timeout)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.DestinationNotAccessible(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def delete(self, path):\n \"\"\"\n Deletes a file from the connected RSE.\n\n :param path: path to the to be deleted file\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'deleting file {}'.format(path))\n\n pfns = [path] if isinstance(path, STRING_TYPES) else path\n\n try:\n status = self.__gfal2_rm(pfns)\n if status:\n raise exception.RucioException()\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def rename(self, path, new_path):\n \"\"\"\n Allows to rename a file stored inside the connected RSE.\n\n :param path: path to the current file on the storage\n :param new_path: path to the new file on the storage\n\n :raises DestinationNotAccessible: if the destination storage was not accessible.\n :raises ServiceUnavailable: if some generic error occured in the library.\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'renaming file from {} to {}'.format(path, new_path))\n\n try:\n status = self.__gfal2_rename(path, new_path)\n if status:\n raise exception.RucioException()\n except exception.DestinationNotAccessible as error:\n raise exception.DestinationNotAccessible(str(error))\n except exception.SourceNotFound as error:\n raise exception.SourceNotFound(str(error))\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def exists(self, path):\n \"\"\"\n Checks if the requested file is known by the referred RSE.\n\n :param path: Physical file name\n\n :returns: True if the file exists, False if it doesn't\n\n :raises SourceNotFound: if the source file was not found on the referred storage.\n \"\"\"\n self.logger(logging.DEBUG, 'checking if file exists {}'.format(path))\n\n try:\n status = self.__gfal2_exist(path)\n if status:\n return False\n return True\n except exception.SourceNotFound:\n return False\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def close(self):\n \"\"\"\n Closes the connection to RSE.\n \"\"\"\n self.logger(logging.DEBUG, 'closing protocol connection')\n del self.__ctx\n self.__ctx = None\n\n def stat(self, path):\n \"\"\"\n Returns the stats of a file.\n\n :param path: path to file\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n\n :returns: a dict with two keys, filesize and an element of GLOBALLY_SUPPORTED_CHECKSUMS.\n \"\"\"\n self.logger(logging.DEBUG, 'getting stats of file {}'.format(path))\n\n ret = {}\n ctx = self.__ctx\n\n path = str(path)\n\n try:\n stat_str = str(ctx.stat(path))\n except Exception as error:\n msg = 'Error while processing gfal stat call. Error: %s'\n raise exception.ServiceUnavailable(msg % str(error))\n\n stats = stat_str.split()\n if len(stats) < 8:\n msg = 'gfal stat call result has unknown format. Result: %s'\n raise exception.ServiceUnavailable(msg % stat_str)\n\n ret['filesize'] = stats[7]\n\n if not self.rse.get('verify_checksum', True):\n return ret\n\n message = \"\\n\"\n try:\n ret[PREFERRED_CHECKSUM] = ctx.checksum(path, str(PREFERRED_CHECKSUM.upper()))\n return ret\n except Exception as error:\n message += 'Error while processing gfal checksum call (%s). Error: %s \\n' % (PREFERRED_CHECKSUM, str(error))\n\n for checksum_name in GLOBALLY_SUPPORTED_CHECKSUMS:\n if checksum_name == PREFERRED_CHECKSUM:\n continue\n try:\n ret[checksum_name] = ctx.checksum(path, str(checksum_name.upper()))\n return ret\n except Exception as error:\n message += 'Error while processing gfal checksum call (%s). Error: %s \\n' % (checksum_name, str(error))\n\n raise exception.RSEChecksumUnavailable(message)\n\n def __gfal2_cancel(self):\n \"\"\"\n Cancel all gfal operations in progress.\n \"\"\"\n self.logger(logging.DEBUG, 'gfal: cancelling all operations')\n\n ctx = self.__ctx\n if ctx:\n ctx.cancel()\n\n def __gfal2_copy(self, src, dest, src_spacetoken=None, dest_spacetoken=None, transfer_timeout=None):\n \"\"\"\n Uses gfal2 to copy file from src to dest.\n\n :param src: Physical source file name\n :param src_spacetoken: The source file's space token\n :param dest: Physical destination file name\n :param dest_spacetoken: The destination file's space token\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :returns: 0 if copied successfully, other than 0 if failed\n\n :raises SourceNotFound: if source file cannot be found.\n :raises RucioException: if it failed to copy the file.\n \"\"\"\n ctx = self.__ctx\n if transfer_timeout:\n ctx.set_opt_integer(\"HTTP PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n ctx.set_opt_integer(\"SRM PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n ctx.set_opt_integer(\"GRIDFTP PLUGIN\", \"OPERATION_TIMEOUT\", int(transfer_timeout))\n watchdog = Timer(int(transfer_timeout) + 60, self.__gfal2_cancel)\n params = ctx.transfer_parameters()\n if src_spacetoken:\n params.src_spacetoken = str(src_spacetoken)\n if dest_spacetoken:\n params.dst_spacetoken = str(dest_spacetoken)\n\n if not (self.renaming and dest.startswith('https')):\n params.create_parent = True\n\n if not self.renaming:\n params.strict_copy = True\n\n try:\n if transfer_timeout:\n params.timeout = int(transfer_timeout)\n watchdog.start()\n ret = ctx.filecopy(params, str(src), str(dest))\n if transfer_timeout:\n watchdog.cancel()\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if transfer_timeout:\n watchdog.cancel()\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def __gfal2_rm(self, paths):\n \"\"\"\n Uses gfal2 to remove the file.\n\n :param path: Physical file name\n\n :returns: 0 if removed successfully, other than 0 if failed\n\n :raises SourceNotFound: if the source file was not found.\n :raises RucioException: if it failed to remove the file.\n \"\"\"\n\n ctx = self.__ctx\n\n try:\n for path in paths:\n if self.__gfal2_exist(path) == 0:\n ret = ctx.unlink(str(path))\n if ret:\n return ret\n else:\n raise exception.SourceNotFound\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def __gfal2_exist(self, path):\n \"\"\"\n Uses gfal2 to check whether the file exists.\n\n :param path: Physical file name\n\n :returns: 0 if it exists, -1 if it doesn't\n\n :raises RucioException: if the error is not source not found.\n \"\"\"\n ctx = self.__ctx\n try:\n if ctx.stat(str(path)):\n return 0\n return -1\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error): # pylint: disable=no-member\n return -1\n raise exception.RucioException(error)\n\n def __gfal2_rename(self, path, new_path):\n \"\"\"\n Uses gfal2 to rename a file.\n\n :param path: path to the current file on the storage\n :param new_path: path to the new file on the storage\n\n :returns: 0 if it exists, -1 if it doesn't\n\n :raises RucioException: if failed.\n \"\"\"\n ctx = self.__ctx\n\n try:\n dir_name = os.path.dirname(new_path)\n # This function will be removed soon. gfal2 will create parent dir automatically.\n try:\n ctx.mkdir_rec(str(dir_name), 0o775)\n except Exception:\n pass\n ret = ctx.rename(str(path), str(new_path))\n return ret\n except gfal2.GError as error: # pylint: disable=no-member\n if error.code == errno.ENOENT or 'No such file' in str(error):\n raise exception.SourceNotFound(error)\n raise exception.RucioException(error)\n\n def get_space_usage(self):\n \"\"\"\n Get RSE space usage information.\n\n :returns: a list with dict containing 'totalsize' and 'unusedsize'\n\n :raises ServiceUnavailable: if some generic error occured in the library.\n \"\"\"\n endpoint_basepath = self.path2pfn(self.attributes['prefix'])\n self.logger(logging.DEBUG, 'getting space usage from {}'.format(endpoint_basepath))\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n\n if space_token is None or space_token == \"\":\n raise exception.RucioException(\"Space token is not defined for protocol: %s\" % (self.attributes['scheme']))\n\n try:\n totalsize, unusedsize = self.__gfal2_get_space_usage(endpoint_basepath, space_token)\n return totalsize, unusedsize\n except Exception as error:\n raise exception.ServiceUnavailable(error)\n\n def __gfal2_get_space_usage(self, path, space_token):\n \"\"\"\n Uses gfal2 to get space usage info with space token.\n\n :param path: the endpoint path\n :param space_token: a string space token. E.g. \"ATLASDATADISK\"\n\n :returns: a list with dict containing 'totalsize' and 'unusedsize'\n\n :raises ServiceUnavailable: if failed.\n \"\"\"\n ctx = self.__ctx\n\n try:\n ret_usage = ctx.getxattr(str(path), str(\"spacetoken.description?\" + space_token))\n usage = json.loads(ret_usage)\n totalsize = usage[0][\"totalsize\"]\n unusedsize = usage[0][\"unusedsize\"]\n return totalsize, unusedsize\n except gfal2.GError as error: # pylint: disable=no-member\n raise Exception(str(error))\n\n\nclass NoRename(Default):\n\n \"\"\" Implementing access to RSEs using the srm protocol without renaming files on upload/download. Necessary for some storage endpoints. \"\"\"\n\n def __init__(self, protocol_attr, rse_settings, logger=logging.log):\n \"\"\" Initializes the object with information about the referred RSE.\n\n :param protocol_attr: Properties of the requested protocol.\n :param rse_settting: The RSE settings.\n :param logger: Optional decorated logger that can be passed from the calling daemons or servers.\n \"\"\"\n super(NoRename, self).__init__(protocol_attr, rse_settings, logger=logger)\n self.renaming = False\n self.attributes.pop('determinism_type', None)\n self.files = []\n\n def rename(self, pfn, new_pfn):\n \"\"\" Allows to rename a file stored inside the connected RSE.\n\n :param pfn: Current physical file name\n :param new_pfn New physical file name\n\n :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound\n \"\"\"\n raise NotImplementedError\n\n\nclass CLI(Default):\n\n \"\"\" Implementing access to RSEs using the srm protocol through CLI with 'gfal' commands. \"\"\"\n\n def __init__(self, protocol_attr, rse_settings, logger=logging.log):\n \"\"\" Initializes the object with information about the referred RSE.\n\n :param props: Properties derived from the RSE Repository\n \"\"\"\n\n super(CLI, self).__init__(protocol_attr, rse_settings, logger=logger)\n if not logger:\n logger = logging.getLogger('%s.null' % __name__)\n self.logger = logger\n\n def get(self, path, dest, transfer_timeout=None):\n \"\"\"\n Provides access to files stored inside connected the RSE.\n\n :param path: Physical file name of requested file\n :param dest: Name and path of the files when stored at the client\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises RucioException: Passthrough of gfal-copy error message.\n \"\"\"\n\n dest = os.path.abspath(dest)\n if ':' not in dest:\n dest = \"file://\" + dest\n\n cmd = 'gfal-copy -vf -p -t %s -T %s %s %s' % (transfer_timeout, transfer_timeout, path, dest)\n self.logger(logging.DEBUG, 'Command: ' + cmd)\n cmd = cmd.split()\n\n p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n stdout, stderr = p.communicate()\n\n if p.returncode:\n self.logger(logging.DEBUG, 'Error STDOUT: ' + str(stdout))\n self.logger(logging.DEBUG, 'Error STDERR: ' + str(stderr))\n raise exception.RucioException(str(stderr))\n\n def put(self, source, target, source_dir, transfer_timeout=None):\n \"\"\"\n Allows to store files inside the referred RSE.\n\n :param source: path to the source file on the client file system\n :param target: path to the destination file on the storage\n :param source_dir: Path where the to be transferred files are stored in the local file system\n :param transfer_timeout: Transfer timeout (in seconds)\n\n :raises RucioException: Passthrough of gfal-copy error message.\n \"\"\"\n\n source_dir = source_dir or '.'\n source_url = '%s/%s' % (source_dir, source)\n self.logger(logging.DEBUG, 'source: ' + str(source_url))\n source_url = os.path.abspath(source_url)\n if not os.path.exists(source_url):\n raise exception.SourceNotFound()\n if ':' not in source_url:\n source_url = \"file://\" + source_url\n\n cmd = 'gfal-copy -vf -p -t %s -T %s %s %s ' % (transfer_timeout, transfer_timeout, source, target)\n\n space_token = None\n if self.attributes['extended_attributes'] is not None and 'space_token' in list(self.attributes['extended_attributes'].keys()):\n space_token = self.attributes['extended_attributes']['space_token']\n cmd = 'gfal-copy -vf -p -t %s -T %s -S %s %s %s ' % (transfer_timeout, transfer_timeout, space_token, source, target)\n\n self.logger(logging.DEBUG, 'Command: ' + cmd)\n cmd = cmd.split()\n\n p = subprocess.Popen(cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE)\n stdout, stderr = p.communicate()\n\n if p.returncode:\n self.logger(logging.DEBUG, 'Error STDOUT: ' + str(stdout))\n self.logger(logging.DEBUG, 'Error STDERR: ' + str(stderr))\n raise exception.RucioException(str(stderr))\n", "path": "lib/rucio/rse/protocols/gfal.py" } ]	diff --git a/lib/rucio/rse/protocols/gfal.py b/lib/rucio/rse/protocols/gfal.py index 580cddaf60..127f11864d 100644 --- a/lib/rucio/rse/protocols/gfal.py +++ b/lib/rucio/rse/protocols/gfal.py @@ -394,6 +394,9 @@ def stat(self, path): ret['filesize'] = stats[7] + if not self.rse.get('verify_checksum', True): + return ret + message = "\n" try: ret[PREFERRED_CHECKSUM] = ctx.checksum(path, str(PREFERRED_CHECKSUM.upper()))
pulp__pulpcore-4405	Querying content in repository versions with lots of content is slow Version All Describe the bug When a repository version has upwards of 50k content in it, querying the content in the repository using `repo_version.get_content()` becomes extremely slow. In my testing the results haven't been consistent, however I have notice queries that can take anywhere from 200ms to 1000ms. This appears to be due to the complex joins that have to be made on version_added and version_removed. To Reproduce - Load up a repository with a lot of content - Perform a query to fetch the last 100 objects or count how many objects are in it - Observe query speeds that would make sonic the hedgehog faint Expected behavior Database queries should be fast. Hopefully less than 50ms for complex ones, ideally lower than that. Some possible solutions - Adding the repo version numbers directly to the RepositoryContent table speeds up queries greatly. My testing showed that this can lower the queryset speed to 80ms with 65k content in some cases. - pulp_ansible is experimenting with querying the repository version table to look up RepositoryContent (https://github.com/pulp/pulp_ansible/blob/main/pulp_ansible/app/utils.py#L5). Results have been mixed with this. In some cases the query efficiency is substantially higher (on the order of 8x improvement). In other cases, it's roughly the same. - Some form of memoization/caching of querysets.	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import Q\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import batch_qs, get_view_name_for_model\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True, unique=True)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n\n class Meta:\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n _(\"Deleting repository version {} due to version retention limit.\").format(\n version\n )\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits total download rate in requests per second.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True, unique=True)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n return self.download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from a relative path.\n\n This method returns the URL for a RemoteArtifact by concatinating the Remote's url and the\n relative path.located in the Remote. Plugin writers are expected to override this method\n when a more complex algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Class: The Class of the content type that should be available at the relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n class Meta:\n default_related_name = \"remotes\"\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n content = models.ForeignKey(\n \"Content\", on_delete=models.CASCADE, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.CASCADE\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\", null=True, related_name=\"removed_memberships\", on_delete=models.CASCADE\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository=self.repository, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(version_memberships__in=self._content_relationships())\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n # use list() to force the evaluation of the queryset, otherwise queryset is affected\n # by the update() operation before delete() is ran\n content_removed_and_readded = list(\n repo_relations.filter(version_removed=self, content_id__in=content_added).values_list(\n \"content_id\"\n )\n )\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.CharField(max_length=1, choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types present in the RepositoryVersion.\n\n For each content type present in the RepositoryVersion, create the URL of the viewset of\n that variety of content along with a query parameter which filters it by presence in this\n RepositoryVersion.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n ctype_model = Content.objects.filter(pulp_type=self.content_type).first().cast().__class__\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n try:\n ctype_url = reverse(ctype_view)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n repository = self.repository_version.repository.cast()\n repository_view = get_view_name_for_model(repository.__class__, \"list\")\n\n repository_url = reverse(repository_view)\n rv_href = (\n repository_url\n + str(repository.pk)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	[ { "content": "\"\"\"\nRepository related Django models.\n\"\"\"\nfrom contextlib import suppress\nfrom gettext import gettext as _\nfrom os import path\nfrom collections import defaultdict\nimport logging\n\nimport django\nfrom asyncio_throttle import Throttler\nfrom dynaconf import settings\nfrom django.core.validators import MinValueValidator\nfrom django.db import models, transaction\nfrom django.db.models import Q\nfrom django.urls import reverse\nfrom django_lifecycle import AFTER_UPDATE, BEFORE_DELETE, hook\nfrom rest_framework.exceptions import APIException\n\nfrom pulpcore.app.util import batch_qs, get_view_name_for_model\nfrom pulpcore.constants import ALL_KNOWN_CONTENT_CHECKSUMS\nfrom pulpcore.download.factory import DownloaderFactory\nfrom pulpcore.exceptions import ResourceImmutableError\n\nfrom pulpcore.cache import Cache\n\nfrom .base import MasterModel, BaseModel\nfrom .content import Artifact, Content\nfrom .fields import EncryptedTextField\nfrom .task import CreatedResource, Task\n\n\n_logger = logging.getLogger(__name__)\n\n\nclass Repository(MasterModel):\n \"\"\"\n Collection of content.\n\n Fields:\n\n name (models.TextField): The repository name.\n description (models.TextField): An optional description.\n next_version (models.PositiveIntegerField): A record of the next version number to be\n created.\n retain_repo_versions (models.PositiveIntegerField): Number of repo versions to keep\n user_hidden (models.BooleanField): Whether to expose this repo to users via the API\n\n Relations:\n\n content (models.ManyToManyField): Associated content.\n remote (models.ForeignKeyField): Associated remote\n \"\"\"\n\n TYPE = \"repository\"\n CONTENT_TYPES = []\n REMOTE_TYPES = []\n\n name = models.TextField(db_index=True, unique=True)\n description = models.TextField(null=True)\n next_version = models.PositiveIntegerField(default=0)\n retain_repo_versions = models.PositiveIntegerField(default=None, null=True)\n user_hidden = models.BooleanField(default=False)\n content = models.ManyToManyField(\n \"Content\", through=\"RepositoryContent\", related_name=\"repositories\"\n )\n remote = models.ForeignKey(\"Remote\", null=True, on_delete=models.SET_NULL)\n\n class Meta:\n verbose_name_plural = \"repositories\"\n\n def on_new_version(self, version):\n \"\"\"Called after a new repository version has been created.\n\n Subclasses are expected to override this to do useful things.\n\n Args:\n version: The new repository version.\n \"\"\"\n pass\n\n def save(self, args, kwargs):\n \"\"\"\n Saves Repository model and creates an initial repository version.\n\n Args:\n args (list): list of positional arguments for Model.save()\n kwargs (dict): dictionary of keyword arguments to pass to Model.save()\n \"\"\"\n with transaction.atomic():\n adding = self._state.adding\n super().save(args, kwargs)\n if adding:\n self.create_initial_version()\n\n def create_initial_version(self):\n \"\"\"\n Create an initial repository version (version 0).\n\n This method can be overriden by plugins if they require custom logic.\n \"\"\"\n version = RepositoryVersion(repository=self, number=self.next_version, complete=True)\n self.next_version += 1\n self.save()\n version.save()\n\n def new_version(self, base_version=None):\n \"\"\"\n Create a new RepositoryVersion for this Repository\n\n Creation of a RepositoryVersion should be done in a RQ Job.\n\n Args:\n repository (pulpcore.app.models.Repository): to create a new version of\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n whose content will be used as the set of content for the new version\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The Created RepositoryVersion\n \"\"\"\n with transaction.atomic():\n latest_version = self.versions.latest()\n if not latest_version.complete:\n latest_version.delete()\n\n version = RepositoryVersion(\n repository=self, number=int(self.next_version), base_version=base_version\n )\n version.save()\n\n if base_version:\n # first remove the content that isn't in the base version\n version.remove_content(version.content.exclude(pk__in=base_version.content))\n # now add any content that's in the base_version but not in version\n version.add_content(base_version.content.exclude(pk__in=version.content))\n\n if Task.current() and not self.user_hidden:\n resource = CreatedResource(content_object=version)\n resource.save()\n\n self.invalidate_cache()\n\n return version\n\n def finalize_new_version(self, new_version):\n \"\"\"\n Finalize the incomplete RepositoryVersion with plugin-provided code.\n\n This method should be overridden by plugin writers for an opportunity for plugin input. This\n method is intended to be called with the incomplete\n :class:`pulpcore.app.models.RepositoryVersion` to validate or modify the content.\n\n This method does not adjust the value of complete, or save the `RepositoryVersion` itself.\n Its intent is to allow the plugin writer an opportunity for plugin input before pulpcore\n marks the `RepositoryVersion` as complete.\n\n Args:\n new_version (pulpcore.app.models.RepositoryVersion): The incomplete RepositoryVersion to\n finalize.\n\n Returns:\n\n \"\"\"\n pass\n\n def latest_version(self):\n \"\"\"\n Get the latest RepositoryVersion on a repository\n\n Args:\n repository (pulpcore.app.models.Repository): to get the latest version of\n\n Returns:\n pulpcore.app.models.RepositoryVersion: The latest RepositoryVersion\n\n \"\"\"\n with suppress(RepositoryVersion.DoesNotExist):\n model = self.versions.complete().latest()\n return model\n\n def natural_key(self):\n \"\"\"\n Get the model's natural key.\n\n :return: The model's natural key.\n :rtype: tuple\n \"\"\"\n return (self.name,)\n\n @staticmethod\n def artifacts_for_version(version):\n \"\"\"\n Return the artifacts for a repository version.\n\n Provides a method that plugins can override since RepositoryVersions aren't typed.\n\n Args:\n version (pulpcore.app.models.RepositoryVersion): to get the artifacts for\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return Artifact.objects.filter(content__pk__in=version.content)\n\n @hook(AFTER_UPDATE, when=\"retain_repo_versions\", has_changed=True)\n def _cleanup_old_versions_hook(self):\n # Do not attempt to clean up anything, while there is a transaction involving repo versions\n # still in flight.\n transaction.on_commit(self.cleanup_old_versions)\n\n def cleanup_old_versions(self):\n \"\"\"Cleanup old repository versions based on retain_repo_versions.\"\"\"\n # I am still curious how, but it was reported that this state can happen in day to day\n # operations but its easy to reproduce manually in the pulpcore shell:\n # https://github.com/pulp/pulpcore/issues/2268\n if self.versions.filter(complete=False).exists():\n raise RuntimeError(\n _(\"Attempt to cleanup old versions, while a new version is in flight.\")\n )\n if self.retain_repo_versions:\n # Consider only completed versions for cleanup\n for version in self.versions.complete().order_by(\"-number\")[\n self.retain_repo_versions :\n ]:\n _logger.info(\n _(\"Deleting repository version {} due to version retention limit.\").format(\n version\n )\n )\n version.delete()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if repository is present.\"\"\"\n if settings.CACHE_ENABLED:\n distributions = self.distributions.all()\n if distributions.exists():\n base_paths = distributions.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n # Could do preloading here for immediate artifacts with artifacts_for_version\n\n\nclass Remote(MasterModel):\n \"\"\"\n A remote source for content.\n\n This is meant to be subclassed by plugin authors as an opportunity to provide plugin-specific\n persistent data attributes for a plugin remote subclass.\n\n This object is a Django model that inherits from :class: `pulpcore.app.models.Remote` which\n provides the platform persistent attributes for a remote object. Plugin authors can add\n additional persistent remote data by subclassing this object and adding Django fields. We\n defer to the Django docs on extending this model definition with additional fields.\n\n Validation of the remote is done at the API level by a plugin defined subclass of\n :class: `pulpcore.plugin.serializers.repository.RemoteSerializer`.\n\n Fields:\n\n name (models.TextField): The remote name.\n url (models.TextField): The URL of an external content source.\n ca_cert (models.TextField): A PEM encoded CA certificate used to validate the\n server certificate presented by the external source.\n client_cert (models.TextField): A PEM encoded client certificate used\n for authentication.\n client_key (models.TextField): A PEM encoded private key used for authentication.\n tls_validation (models.BooleanField): If True, TLS peer validation must be performed.\n proxy_url (models.TextField): The optional proxy URL.\n Format: scheme://host:port\n proxy_username (models.TextField): The optional username to authenticate with the proxy.\n proxy_password (models.TextField): The optional password to authenticate with the proxy.\n username (models.TextField): The username to be used for authentication when syncing.\n password (models.TextField): The password to be used for authentication when syncing.\n download_concurrency (models.PositiveIntegerField): Total number of\n simultaneous connections allowed to any remote during a sync.\n policy (models.TextField): The policy to use when downloading content.\n total_timeout (models.FloatField): Value for aiohttp.ClientTimeout.total on connections\n connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.connect\n sock_connect_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_connect\n sock_read_timeout (models.FloatField): Value for aiohttp.ClientTimeout.sock_read\n headers (models.JSONField): Headers set on the aiohttp.ClientSession\n rate_limit (models.IntegerField): Limits total download rate in requests per second.\n \"\"\"\n\n TYPE = \"remote\"\n\n # Constants for the ChoiceField 'policy'\n IMMEDIATE = \"immediate\"\n ON_DEMAND = \"on_demand\"\n STREAMED = \"streamed\"\n\n DEFAULT_DOWNLOAD_CONCURRENCY = 10\n DEFAULT_MAX_RETRIES = 3\n\n POLICY_CHOICES = (\n (IMMEDIATE, \"When syncing, download all metadata and content now.\"),\n (\n ON_DEMAND,\n \"When syncing, download metadata, but do not download content now. Instead, \"\n \"download content as clients request it, and save it in Pulp to be served for \"\n \"future client requests.\",\n ),\n (\n STREAMED,\n \"When syncing, download metadata, but do not download content now. Instead,\"\n \"download content as clients request it, but never save it in Pulp. This causes \"\n \"future requests for that same content to have to be downloaded again.\",\n ),\n )\n\n name = models.TextField(db_index=True, unique=True)\n\n url = models.TextField()\n\n ca_cert = models.TextField(null=True)\n client_cert = models.TextField(null=True)\n client_key = EncryptedTextField(null=True)\n tls_validation = models.BooleanField(default=True)\n\n username = EncryptedTextField(null=True)\n password = EncryptedTextField(null=True)\n\n proxy_url = models.TextField(null=True)\n proxy_username = EncryptedTextField(null=True)\n proxy_password = EncryptedTextField(null=True)\n\n download_concurrency = models.PositiveIntegerField(\n null=True, validators=[MinValueValidator(1, \"Download concurrency must be at least 1\")]\n )\n max_retries = models.PositiveIntegerField(null=True)\n policy = models.TextField(choices=POLICY_CHOICES, default=IMMEDIATE)\n\n total_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_connect_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n sock_read_timeout = models.FloatField(\n null=True, validators=[MinValueValidator(0.0, \"Timeout must be >= 0\")]\n )\n headers = models.JSONField(blank=True, null=True)\n rate_limit = models.IntegerField(null=True)\n\n @property\n def download_factory(self):\n \"\"\"\n Return the DownloaderFactory which can be used to generate asyncio capable downloaders.\n\n Upon first access, the DownloaderFactory is instantiated and saved internally.\n\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n DownloadFactory: The instantiated DownloaderFactory to be used by\n get_downloader().\n \"\"\"\n try:\n return self._download_factory\n except AttributeError:\n self._download_factory = DownloaderFactory(self)\n return self._download_factory\n\n @property\n def download_throttler(self):\n \"\"\"\n Return the Throttler which can be used to rate limit downloaders.\n\n Upon first access, the Throttler is instantiated and saved internally.\n Plugin writers are expected to override when additional configuration of the\n DownloaderFactory is needed.\n\n Returns:\n Throttler: The instantiated Throttler to be used by get_downloader()\n\n \"\"\"\n try:\n return self._download_throttler\n except AttributeError:\n if self.rate_limit:\n self._download_throttler = Throttler(rate_limit=self.rate_limit)\n return self._download_throttler\n\n def get_downloader(self, remote_artifact=None, url=None, kwargs):\n \"\"\"\n Get a downloader from either a RemoteArtifact or URL that is configured with this Remote.\n\n This method accepts either `remote_artifact` or `url` but not both. At least one is\n required. If neither or both are passed a ValueError is raised.\n\n Plugin writers are expected to override when additional configuration is needed or when\n another class of download is required.\n\n Args:\n remote_artifact (:class:`~pulpcore.app.models.RemoteArtifact`): The RemoteArtifact to\n download.\n url (str): The URL to download.\n kwargs (dict): This accepts the parameters of\n :class:`~pulpcore.plugin.download.BaseDownloader`.\n\n Raises:\n ValueError: If neither remote_artifact and url are passed, or if both are passed.\n\n Returns:\n subclass of :class:`~pulpcore.plugin.download.BaseDownloader`: A downloader that\n is configured with the remote settings.\n \"\"\"\n if remote_artifact and url:\n raise ValueError(_(\"get_downloader() cannot accept both 'remote_artifact' and 'url'.\"))\n if remote_artifact is None and url is None:\n raise ValueError(_(\"get_downloader() requires either 'remote_artifact' and 'url'.\"))\n if remote_artifact:\n url = remote_artifact.url\n expected_digests = {}\n for digest_name in ALL_KNOWN_CONTENT_CHECKSUMS:\n digest_value = getattr(remote_artifact, digest_name)\n if digest_value:\n expected_digests[digest_name] = digest_value\n if expected_digests:\n kwargs[\"expected_digests\"] = expected_digests\n if remote_artifact.size:\n kwargs[\"expected_size\"] = remote_artifact.size\n return self.download_factory.build(url, *kwargs)\n\n def get_remote_artifact_url(self, relative_path=None):\n \"\"\"\n Get the full URL for a RemoteArtifact from a relative path.\n\n This method returns the URL for a RemoteArtifact by concatinating the Remote's url and the\n relative path.located in the Remote. Plugin writers are expected to override this method\n when a more complex algorithm is needed to determine the full URL.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Raises:\n ValueError: If relative_path starts with a '/'.\n\n Returns:\n str: A URL for a RemoteArtifact available at the Remote.\n \"\"\"\n if path.isabs(relative_path):\n raise ValueError(_(\"Relative path can't start with '/'. {0}\").format(relative_path))\n return path.join(self.url, relative_path)\n\n def get_remote_artifact_content_type(self, relative_path=None):\n \"\"\"\n Get the type of content that should be available at the relative path.\n\n Plugin writers are expected to implement this method.\n\n Args:\n relative_path (str): The relative path of a RemoteArtifact\n\n Returns:\n Class: The Class of the content type that should be available at the relative path.\n \"\"\"\n raise NotImplementedError()\n\n @hook(BEFORE_DELETE)\n def invalidate_cache(self):\n \"\"\"Invalidates the cache if remote is present.\"\"\"\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n class Meta:\n default_related_name = \"remotes\"\n\n\nclass RepositoryContent(BaseModel):\n \"\"\"\n Association between a repository and its contained content.\n\n Fields:\n\n created (models.DatetimeField): When the association was created.\n\n Relations:\n\n content (models.ForeignKey): The associated content.\n repository (models.ForeignKey): The associated repository.\n version_added (models.ForeignKey): The RepositoryVersion which added the referenced\n Content.\n version_removed (models.ForeignKey): The RepositoryVersion which removed the referenced\n Content.\n \"\"\"\n\n content = models.ForeignKey(\n \"Content\", on_delete=models.CASCADE, related_name=\"version_memberships\"\n )\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n version_added = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"added_memberships\", on_delete=models.CASCADE\n )\n version_removed = models.ForeignKey(\n \"RepositoryVersion\", null=True, related_name=\"removed_memberships\", on_delete=models.CASCADE\n )\n\n class Meta:\n unique_together = (\n (\"repository\", \"content\", \"version_added\"),\n (\"repository\", \"content\", \"version_removed\"),\n )\n\n\nclass RepositoryVersionQuerySet(models.QuerySet):\n \"\"\"A queryset that provides repository version filtering methods.\"\"\"\n\n def complete(self):\n return self.filter(complete=True)\n\n def with_content(self, content):\n \"\"\"\n Filters repository versions that contain the provided content units.\n\n Args:\n content (django.db.models.QuerySet): query of content\n\n Returns:\n django.db.models.QuerySet: Repository versions which contains content.\n \"\"\"\n query = models.Q(pk__in=[])\n repo_content = RepositoryContent.objects.filter(content__pk__in=content)\n\n for rc in repo_content.iterator():\n filter = models.Q(\n repository__pk=rc.repository.pk,\n number__gte=rc.version_added.number,\n )\n if rc.version_removed:\n filter &= models.Q(number__lt=rc.version_removed.number)\n\n query \|= filter\n\n return self.filter(query)\n\n\nclass RepositoryVersion(BaseModel):\n \"\"\"\n A version of a repository's content set.\n\n Plugin Writers are strongly encouraged to use RepositoryVersion as a context manager to provide\n transactional safety, working directory set up, plugin finalization, and cleaning up the\n database on failures.\n\n Examples::\n\n with repository.new_version(repository) as new_version:\n new_version.add_content(content_q)\n new_version.remove_content(content_q)\n\n Fields:\n\n number (models.PositiveIntegerField): A positive integer that uniquely identifies a version\n of a specific repository. Each new version for a repo should have this field set to\n 1 + the most recent version.\n complete (models.BooleanField): If true, the RepositoryVersion is visible. This field is set\n to true when the task that creates the RepositoryVersion is complete.\n\n Relations:\n\n repository (models.ForeignKey): The associated repository.\n base_version (models.ForeignKey): The repository version this was created from.\n \"\"\"\n\n objects = RepositoryVersionQuerySet.as_manager()\n\n repository = models.ForeignKey(Repository, on_delete=models.CASCADE)\n number = models.PositiveIntegerField(db_index=True)\n complete = models.BooleanField(db_index=True, default=False)\n base_version = models.ForeignKey(\"RepositoryVersion\", null=True, on_delete=models.SET_NULL)\n\n class Meta:\n default_related_name = \"versions\"\n unique_together = (\"repository\", \"number\")\n get_latest_by = \"number\"\n ordering = (\"number\",)\n\n def _content_relationships(self):\n \"\"\"\n Returns a set of repository_content for a repository version\n\n Returns:\n django.db.models.QuerySet: The repository_content that is contained within this version.\n \"\"\"\n return RepositoryContent.objects.filter(\n repository=self.repository, version_added__number__lte=self.number\n ).exclude(version_removed__number__lte=self.number)\n\n def get_content(self, content_qs=None):\n \"\"\"\n Returns a set of content for a repository version\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to return over all content types present in the\n repository version).\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> # Return a queryset of File objects in the repository\n >>> repository_version.get_content(content_qs=File.objects)):\n \"\"\"\n\n if content_qs is None:\n content_qs = Content.objects\n\n return content_qs.filter(pk__in=self._content_relationships().values_list(\"content_id\"))\n\n @property\n def content(self):\n \"\"\"\n Returns a set of content for a repository version\n\n Returns:\n django.db.models.QuerySet: The content that is contained within this version.\n\n Examples:\n >>> repository_version = ...\n >>>\n >>> for content in repository_version.content:\n >>> content = content.cast() # optional downcast.\n >>> ...\n >>>\n >>> for content in FileContent.objects.filter(pk__in=repository_version.content):\n >>> ...\n >>>\n \"\"\"\n\n return self.get_content()\n\n def content_batch_qs(self, content_qs=None, order_by_params=(\"pk\",), batch_size=1000):\n \"\"\"\n Generate content batches to efficiently iterate over all content.\n\n Generates query sets that span the `content_qs` content of the repository\n version. Each yielded query set evaluates to at most `batch_size` content records.\n This is useful to limit the memory footprint when iterating over all content of\n a repository version.\n\n .. note::\n\n This generator is not safe against changes (i.e. add/remove content) during\n the iteration!\n\n * As the method uses slices internally, the queryset must be ordered to yield\n stable results. By default, it is ordered by primary key.\n\n Args:\n content_qs (:class:`django.db.models.QuerySet`): The queryset for Content that will be\n restricted further to the content present in this repository version. If not given,\n ``Content.objects.all()`` is used (to iterate over all content present in the\n repository version). A plugin may want to use a specific subclass of\n :class:`~pulpcore.plugin.models.Content` or use e.g. ``filter()`` to select\n a subset of the repository version's content.\n order_by_params (tuple of str): The parameters for the ``order_by`` clause\n for the content. The Default is ``(\"pk\",)``. This needs to\n specify a stable order. For example, if you want to iterate by\n decreasing creation time stamps use ``(\"-pulp_created\", \"pk\")`` to\n ensure that content records are still sorted by primary key even\n if their creation timestamp happens to be equal.\n batch_size (int): The maximum batch size.\n\n Yields:\n :class:`django.db.models.QuerySet`: A QuerySet representing a slice of the content.\n\n Example:\n The following code could be used to loop over all ``FileContent`` in\n ``repository_version``. It prefetches the related\n :class:`~pulpcore.plugin.models.ContentArtifact` instances for every batch::\n\n repository_version = ...\n\n batch_generator = repository_version.content_batch_qs(\n content_class=FileContent.objects.all()\n )\n for content_batch_qs in batch_generator:\n content_batch_qs.prefetch_related(\"contentartifact_set\")\n for content in content_batch_qs:\n ...\n\n \"\"\"\n version_content_qs = self.get_content(content_qs).order_by(order_by_params)\n yield from batch_qs(version_content_qs, batch_size=batch_size)\n\n @property\n def artifacts(self):\n \"\"\"\n Returns a set of artifacts for a repository version.\n\n Returns:\n django.db.models.QuerySet: The artifacts that are contained within this version.\n \"\"\"\n return self.repository.cast().artifacts_for_version(self)\n\n def added(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were added by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_added=self)\n\n return Content.objects.filter(\n version_memberships__in=self._content_relationships()\n ).exclude(version_memberships__in=base_version._content_relationships())\n\n def removed(self, base_version=None):\n \"\"\"\n Args:\n base_version (pulpcore.app.models.RepositoryVersion): an optional repository version\n\n Returns:\n QuerySet: The Content objects that were removed by this version.\n \"\"\"\n if not base_version:\n return Content.objects.filter(version_memberships__version_removed=self)\n\n return Content.objects.filter(\n version_memberships__in=base_version._content_relationships()\n ).exclude(version_memberships__in=self._content_relationships())\n\n def contains(self, content):\n \"\"\"\n Check whether a content exists in this repository version's set of content\n\n Returns:\n bool: True if the repository version contains the content, False otherwise\n \"\"\"\n return self.content.filter(pk=content.pk).exists()\n\n def add_content(self, content):\n \"\"\"\n Add a content unit to this version.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to add\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if add_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n repo_content = []\n to_add = set(content.exclude(pk__in=self.content).values_list(\"pk\", flat=True))\n\n # Normalize representation if content has already been removed in this version and\n # is re-added: Undo removal by setting version_removed to None.\n for removed in batch_qs(self.removed().order_by(\"pk\").values_list(\"pk\", flat=True)):\n to_readd = to_add.intersection(set(removed))\n if to_readd:\n RepositoryContent.objects.filter(\n content__in=to_readd, repository=self.repository, version_removed=self\n ).update(version_removed=None)\n to_add = to_add - to_readd\n\n for content_pk in to_add:\n repo_content.append(\n RepositoryContent(\n repository=self.repository, content_id=content_pk, version_added=self\n )\n )\n\n RepositoryContent.objects.bulk_create(repo_content)\n\n def remove_content(self, content):\n \"\"\"\n Remove content from the repository.\n\n Args:\n content (django.db.models.QuerySet): Set of Content to remove\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if remove_content is called on a\n complete RepositoryVersion\n \"\"\"\n\n if self.complete:\n raise ResourceImmutableError(self)\n\n if not content or not content.count():\n return\n\n # Normalize representation if content has already been added in this version.\n # Undo addition by deleting the RepositoryContent.\n RepositoryContent.objects.filter(\n repository=self.repository,\n content_id__in=content,\n version_added=self,\n version_removed=None,\n ).delete()\n\n q_set = RepositoryContent.objects.filter(\n repository=self.repository, content_id__in=content, version_removed=None\n )\n q_set.update(version_removed=self)\n\n def set_content(self, content):\n \"\"\"\n Sets the repo version content by calling remove_content() then add_content().\n\n Args:\n content (django.db.models.QuerySet): Set of desired content\n\n Raise:\n pulpcore.exception.ResourceImmutableError: if set_content is called on a\n complete RepositoryVersion\n \"\"\"\n self.remove_content(self.content.exclude(pk__in=content))\n self.add_content(content.exclude(pk__in=self.content))\n\n def next(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The next complete RepositoryVersion for the same\n repository.\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a higher \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__gt=self.number)\n .order_by(\"number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def previous(self):\n \"\"\"\n Returns:\n pulpcore.app.models.RepositoryVersion: The previous complete RepositoryVersion for the\n same repository.\n\n Raises:\n RepositoryVersion.DoesNotExist: if there is not a RepositoryVersion for the same\n repository and with a lower \"number\".\n \"\"\"\n try:\n return (\n self.repository.versions.complete()\n .filter(number__lt=self.number)\n .order_by(\"-number\")[0]\n )\n except IndexError:\n raise self.DoesNotExist\n\n def _squash(self, repo_relations, next_version):\n \"\"\"\n Squash a complete repo version into the next version\n \"\"\"\n # delete any relationships added in the version being deleted and removed in the next one.\n repo_relations.filter(version_added=self, version_removed=next_version).delete()\n\n # If the same content is deleted in version, but added back in next_version then:\n # - set version_removed field in relation to version_removed of the relation adding\n # the content in next version because the content can be removed again after the\n # next_version\n # - and remove relation adding the content in next_version\n content_added = repo_relations.filter(version_added=next_version).values_list(\"content_id\")\n\n # use list() to force the evaluation of the queryset, otherwise queryset is affected\n # by the update() operation before delete() is ran\n content_removed_and_readded = list(\n repo_relations.filter(version_removed=self, content_id__in=content_added).values_list(\n \"content_id\"\n )\n )\n\n repo_contents_readded_in_next_version = repo_relations.filter(\n version_added=next_version, content_id__in=content_removed_and_readded\n )\n\n # Since the readded contents can be removed again by any subsequent version after the\n # next version. Get the mapping of readded contents and their versions removed to use\n # later. The version removed id will be None if a content is not removed.\n version_removed_id_content_id_map = defaultdict(list)\n for readded_repo_content in repo_contents_readded_in_next_version.iterator():\n version_removed_id_content_id_map[readded_repo_content.version_removed_id].append(\n readded_repo_content.content_id\n )\n\n repo_contents_readded_in_next_version.delete()\n\n # Update the version removed of the readded contents\n for version_removed_id, content_ids in version_removed_id_content_id_map.items():\n repo_relations.filter(version_removed=self, content_id__in=content_ids).update(\n version_removed_id=version_removed_id\n )\n\n # \"squash\" by moving other additions and removals forward to the next version\n repo_relations.filter(version_added=self).update(version_added=next_version)\n repo_relations.filter(version_removed=self).update(version_removed=next_version)\n\n # Update next version's counts as they have been modified\n next_version._compute_counts()\n\n def delete(self, kwargs):\n \"\"\"\n Deletes a RepositoryVersion\n\n If RepositoryVersion is complete and has a successor, squash RepositoryContent changes into\n the successor. If version is incomplete, delete and and clean up RepositoryContent,\n CreatedResource, and Repository objects.\n\n Deletion of a complete RepositoryVersion should be done in a RQ Job.\n \"\"\"\n if self.complete:\n if self.repository.versions.complete().count() <= 1:\n raise APIException(_(\"Attempt to delete the last remaining version.\"))\n if settings.CACHE_ENABLED:\n base_paths = self.distribution_set.values_list(\"base_path\", flat=True)\n if base_paths:\n Cache().delete(base_key=base_paths)\n\n # Handle the manipulation of the repository version content and its final deletion in\n # the same transaction.\n with transaction.atomic():\n repo_relations = RepositoryContent.objects.filter(\n repository=self.repository\n ).select_for_update()\n try:\n next_version = self.next()\n self._squash(repo_relations, next_version)\n\n except RepositoryVersion.DoesNotExist:\n # version is the latest version so simply update repo contents\n # and delete the version\n repo_relations.filter(version_added=self).delete()\n repo_relations.filter(version_removed=self).update(version_removed=None)\n\n if repo_relations.filter(Q(version_added=self) \| Q(version_removed=self)).exists():\n raise RuntimeError(\n _(\"Some repo relations of this version were not translated.\")\n )\n super().delete(kwargs)\n\n else:\n with transaction.atomic():\n RepositoryContent.objects.filter(version_added=self).delete()\n RepositoryContent.objects.filter(version_removed=self).update(version_removed=None)\n CreatedResource.objects.filter(object_id=self.pk).delete()\n super().delete(*kwargs)\n\n def _compute_counts(self):\n \"\"\"\n Compute and save content unit counts by type.\n\n Count records are stored as :class:`~pulpcore.app.models.RepositoryVersionContentDetails`.\n This method deletes existing :class:`~pulpcore.app.models.RepositoryVersionContentDetails`\n objects and makes new ones with each call.\n \"\"\"\n with transaction.atomic():\n counts_list = []\n for value, name in RepositoryVersionContentDetails.COUNT_TYPE_CHOICES:\n RepositoryVersionContentDetails.objects.filter(repository_version=self).delete()\n if value == RepositoryVersionContentDetails.ADDED:\n qs = self.added()\n elif value == RepositoryVersionContentDetails.PRESENT:\n qs = self.content\n elif value == RepositoryVersionContentDetails.REMOVED:\n qs = self.removed()\n annotated = qs.values(\"pulp_type\").annotate(count=models.Count(\"pulp_type\"))\n for item in annotated:\n count_obj = RepositoryVersionContentDetails(\n content_type=item[\"pulp_type\"],\n repository_version=self,\n count=item[\"count\"],\n count_type=value,\n )\n counts_list.append(count_obj)\n RepositoryVersionContentDetails.objects.bulk_create(counts_list)\n\n def __enter__(self):\n \"\"\"\n Create the repository version\n\n Returns:\n RepositoryVersion: self\n \"\"\"\n if self.complete:\n raise RuntimeError(\n _(\"This Repository version is complete. It cannot be modified further.\")\n )\n return self\n\n def __exit__(self, exc_type, exc_value, traceback):\n \"\"\"\n Finalize and save the RepositoryVersion if no errors are raised, delete it if not\n \"\"\"\n if exc_value:\n self.delete()\n else:\n try:\n repository = self.repository.cast()\n repository.finalize_new_version(self)\n no_change = not self.added() and not self.removed()\n if no_change:\n self.delete()\n else:\n content_types_seen = set(\n self.content.values_list(\"pulp_type\", flat=True).distinct()\n )\n content_types_supported = set(\n ctype.get_pulp_type() for ctype in repository.CONTENT_TYPES\n )\n\n unsupported_types = content_types_seen - content_types_supported\n if unsupported_types:\n raise ValueError(\n _(\"Saw unsupported content types {}\").format(unsupported_types)\n )\n\n self.complete = True\n self.repository.next_version = self.number + 1\n with transaction.atomic():\n self.repository.save()\n self.save()\n self._compute_counts()\n self.repository.cleanup_old_versions()\n repository.on_new_version(self)\n except Exception:\n self.delete()\n raise\n\n def __str__(self):\n return \"<Repository: {}; Version: {}>\".format(self.repository.name, self.number)\n\n\nclass RepositoryVersionContentDetails(models.Model):\n ADDED = \"A\"\n PRESENT = \"P\"\n REMOVED = \"R\"\n COUNT_TYPE_CHOICES = (\n (ADDED, \"added\"),\n (PRESENT, \"present\"),\n (REMOVED, \"removed\"),\n )\n\n count_type = models.CharField(max_length=1, choices=COUNT_TYPE_CHOICES)\n content_type = models.TextField()\n repository_version = models.ForeignKey(\n \"RepositoryVersion\", related_name=\"counts\", on_delete=models.CASCADE\n )\n count = models.IntegerField()\n\n @property\n def content_href(self):\n \"\"\"\n Generate URLs for the content types present in the RepositoryVersion.\n\n For each content type present in the RepositoryVersion, create the URL of the viewset of\n that variety of content along with a query parameter which filters it by presence in this\n RepositoryVersion.\n\n Args:\n obj (pulpcore.app.models.RepositoryVersion): The RepositoryVersion being serialized.\n Returns:\n dict: {<pulp_type>: <url>}\n \"\"\"\n ctype_model = Content.objects.filter(pulp_type=self.content_type).first().cast().__class__\n ctype_view = get_view_name_for_model(ctype_model, \"list\")\n try:\n ctype_url = reverse(ctype_view)\n except django.urls.exceptions.NoReverseMatch:\n # We've hit a content type for which there is no viewset.\n # There's nothing we can do here, except to skip it.\n return\n repository = self.repository_version.repository.cast()\n repository_view = get_view_name_for_model(repository.__class__, \"list\")\n\n repository_url = reverse(repository_view)\n rv_href = (\n repository_url\n + str(repository.pk)\n + \"/versions/{version}/\".format(version=self.repository_version.number)\n )\n if self.count_type == self.ADDED:\n partial_url_str = \"{base}?repository_version_added={rv_href}\"\n elif self.count_type == self.PRESENT:\n partial_url_str = \"{base}?repository_version={rv_href}\"\n elif self.count_type == self.REMOVED:\n partial_url_str = \"{base}?repository_version_removed={rv_href}\"\n full_url = partial_url_str.format(base=ctype_url, rv_href=rv_href)\n return full_url\n", "path": "pulpcore/app/models/repository.py" } ]	diff --git a/CHANGES/3969.bugfix b/CHANGES/3969.bugfix new file mode 100644 index 0000000000..c283c14070 --- /dev/null +++ b/CHANGES/3969.bugfix @@ -0,0 +1 @@ +Improved the performance when looking up content for repository versions. diff --git a/pulpcore/app/models/repository.py b/pulpcore/app/models/repository.py index ffd2b370f8..43e4daca1b 100644 --- a/pulpcore/app/models/repository.py +++ b/pulpcore/app/models/repository.py @@ -617,7 +617,7 @@ def get_content(self, content_qs=None): if content_qs is None: content_qs = Content.objects - return content_qs.filter(version_memberships__in=self._content_relationships()) + return content_qs.filter(pk__in=self._content_relationships().values_list("content_id")) @property def content(self):
spotify__luigi-1494	Python 3.5 support Luigi may already work with Python 3.5, but since the README doesn't mention it I thought I'd ask. Does Luigi support Python 3.5?	[ { "content": "# Copyright (c) 2012 Spotify AB\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\"); you may not\n# use this file except in compliance with the License. You may obtain a copy of\n# the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations under\n# the License.\n\nimport os\n\nfrom setuptools import setup\n\n\ndef get_static_files(path):\n return [os.path.join(dirpath.replace(\"luigi/\", \"\"), ext)\n for (dirpath, dirnames, filenames) in os.walk(path)\n for ext in [\".html\", \".js\", \".css\", \".png\",\n \".eot\", \".svg\", \".ttf\", \".woff\", \"*.woff2\"]]\n\n\nluigi_package_data = sum(map(get_static_files, [\"luigi/static\", \"luigi/templates\"]), [])\n\nreadme_note = \"\"\"\\\n.. note::\n\n For the latest source, discussion, etc, please visit the\n `GitHub repository <https://github.com/spotify/luigi>`_\\n\\n\n\"\"\"\n\nwith open('README.rst') as fobj:\n long_description = readme_note + fobj.read()\n\ninstall_requires = [\n 'tornado>=4.0,<5',\n 'python-daemon<3.0',\n]\n\nif os.environ.get('READTHEDOCS', None) == 'True':\n # So that we can build documentation for luigi.db_task_history and luigi.contrib.sqla\n install_requires.append('sqlalchemy')\n # readthedocs don't like python-daemon, see #1342\n install_requires.remove('python-daemon<3.0')\n\nsetup(\n name='luigi',\n version='2.0.1',\n description='Workflow mgmgt + task scheduling + dependency resolution',\n long_description=long_description,\n author='Erik Bernhardsson',\n url='https://github.com/spotify/luigi',\n license='Apache License 2.0',\n packages=[\n 'luigi',\n 'luigi.contrib',\n 'luigi.contrib.hdfs',\n 'luigi.tools'\n ],\n package_data={\n 'luigi': luigi_package_data\n },\n entry_points={\n 'console_scripts': [\n 'luigi = luigi.cmdline:luigi_run',\n 'luigid = luigi.cmdline:luigid',\n 'luigi-grep = luigi.tools.luigi_grep:main',\n 'luigi-deps = luigi.tools.deps:main',\n 'luigi-migrate = luigi.tools.migrate:main'\n ]\n },\n install_requires=install_requires,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Console',\n 'Environment :: Web Environment',\n 'Intended Audience :: Developers',\n 'Intended Audience :: System Administrators',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.3',\n 'Programming Language :: Python :: 3.4',\n 'Topic :: System :: Monitoring',\n ],\n)\n", "path": "setup.py" } ]	[ { "content": "# Copyright (c) 2012 Spotify AB\n#\n# Licensed under the Apache License, Version 2.0 (the \"License\"); you may not\n# use this file except in compliance with the License. You may obtain a copy of\n# the License at\n#\n# http://www.apache.org/licenses/LICENSE-2.0\n#\n# Unless required by applicable law or agreed to in writing, software\n# distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\n# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\n# License for the specific language governing permissions and limitations under\n# the License.\n\nimport os\n\nfrom setuptools import setup\n\n\ndef get_static_files(path):\n return [os.path.join(dirpath.replace(\"luigi/\", \"\"), ext)\n for (dirpath, dirnames, filenames) in os.walk(path)\n for ext in [\".html\", \".js\", \".css\", \".png\",\n \".eot\", \".svg\", \".ttf\", \".woff\", \"*.woff2\"]]\n\n\nluigi_package_data = sum(map(get_static_files, [\"luigi/static\", \"luigi/templates\"]), [])\n\nreadme_note = \"\"\"\\\n.. note::\n\n For the latest source, discussion, etc, please visit the\n `GitHub repository <https://github.com/spotify/luigi>`_\\n\\n\n\"\"\"\n\nwith open('README.rst') as fobj:\n long_description = readme_note + fobj.read()\n\ninstall_requires = [\n 'tornado>=4.0,<5',\n 'python-daemon<3.0',\n]\n\nif os.environ.get('READTHEDOCS', None) == 'True':\n # So that we can build documentation for luigi.db_task_history and luigi.contrib.sqla\n install_requires.append('sqlalchemy')\n # readthedocs don't like python-daemon, see #1342\n install_requires.remove('python-daemon<3.0')\n\nsetup(\n name='luigi',\n version='2.0.1',\n description='Workflow mgmgt + task scheduling + dependency resolution',\n long_description=long_description,\n author='Erik Bernhardsson',\n url='https://github.com/spotify/luigi',\n license='Apache License 2.0',\n packages=[\n 'luigi',\n 'luigi.contrib',\n 'luigi.contrib.hdfs',\n 'luigi.tools'\n ],\n package_data={\n 'luigi': luigi_package_data\n },\n entry_points={\n 'console_scripts': [\n 'luigi = luigi.cmdline:luigi_run',\n 'luigid = luigi.cmdline:luigid',\n 'luigi-grep = luigi.tools.luigi_grep:main',\n 'luigi-deps = luigi.tools.deps:main',\n 'luigi-migrate = luigi.tools.migrate:main'\n ]\n },\n install_requires=install_requires,\n classifiers=[\n 'Development Status :: 5 - Production/Stable',\n 'Environment :: Console',\n 'Environment :: Web Environment',\n 'Intended Audience :: Developers',\n 'Intended Audience :: System Administrators',\n 'License :: OSI Approved :: Apache Software License',\n 'Programming Language :: Python :: 2.7',\n 'Programming Language :: Python :: 3.3',\n 'Programming Language :: Python :: 3.4',\n 'Programming Language :: Python :: 3.5',\n 'Topic :: System :: Monitoring',\n ],\n)\n", "path": "setup.py" } ]	diff --git a/.travis.yml b/.travis.yml index 1cf88120f2..f7e3c9a0ac 100644 --- a/.travis.yml +++ b/.travis.yml @@ -30,6 +30,17 @@ env: - TOXENV=py27-postgres - TOXENV=visualiser +# Python 3.5 has to go here until Travis adds it to the default build images. +# https://github.com/travis-ci/travis-ci/issues/4794#issuecomment-143758799 +matrix: + include: + - python: 3.5 + env: TOXENV=py35-nonhdfs + - python: 3.5 + env: TOXENV=py35-unixsocket + - python: 3.5 + env: TOXENV=py35-cdh + sudo: false cache: diff --git a/README.rst b/README.rst index 139839cf66..8b3f291208 100644 --- a/README.rst +++ b/README.rst @@ -17,7 +17,7 @@ .. image:: https://img.shields.io/pypi/l/luigi.svg?style=flat :target: https://pypi.python.org/pypi/luigi -Luigi is a Python (2.7, 3.3, 3.4) package that helps you build complex pipelines of batch +Luigi is a Python (2.7, 3.3, 3.4, 3.5) package that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization, handling failures, command line integration, and much more. diff --git a/setup.py b/setup.py index 6a5d7f0bc7..64bf483028 100644 --- a/setup.py +++ b/setup.py @@ -84,6 +84,7 @@ def get_static_files(path): 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3.3', 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', 'Topic :: System :: Monitoring', ], ) diff --git a/test/worker_parallel_scheduling_test.py b/test/worker_parallel_scheduling_test.py index f8725d4823..e3ffa8fc95 100644 --- a/test/worker_parallel_scheduling_test.py +++ b/test/worker_parallel_scheduling_test.py @@ -149,7 +149,7 @@ def test_raise_unpicklable_exception_in_complete(self, send): UnpicklableExceptionTask().complete() except Exception as e: ex = e - self.assertRaises(pickle.PicklingError, pickle.dumps, ex) + self.assertRaises(Exception, pickle.dumps, ex) # verify this can run async self.w.add(UnpicklableExceptionTask(), multiprocess=True) diff --git a/tox.ini b/tox.ini index e5dafabd96..e3b7b88bf5 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py{27,33,34}-{cdh,hdp,nonhdfs,gcloud,postgres,unixsocket}, visualiser, pypy-scheduler, docs, flake8 +envlist = py{27,33,34,35}-{cdh,hdp,nonhdfs,gcloud,postgres,unixsocket}, visualiser, pypy-scheduler, docs, flake8 skipsdist = True [testenv]
coala__coala-6088	Small typo in coalib/output/printers/LogPrinter.py Should read responsibility instead of reponsibility.	[ { "content": "import traceback\nimport logging\n\nfrom coalib.output.printers.LOG_LEVEL import LOG_LEVEL\nfrom coalib.processes.communication.LogMessage import LogMessage\n\n\nclass LogPrinterMixin:\n \"\"\"\n Provides access to the logging interfaces (e.g. err, warn, info) by routing\n them to the log_message method, which should be implemented by descendants\n of this class.\n \"\"\"\n\n def debug(self, messages, delimiter=' ', timestamp=None, kwargs):\n self.log_message(LogMessage(LOG_LEVEL.DEBUG,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def info(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.INFO,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def warn(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.WARNING,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def err(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.ERROR,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n kwargs)\n\n def log(self, log_level, message, timestamp=None, kwargs):\n self.log_message(LogMessage(log_level,\n message,\n timestamp=timestamp),\n kwargs)\n\n def log_exception(self,\n message,\n exception,\n log_level=LOG_LEVEL.ERROR,\n timestamp=None,\n kwargs):\n \"\"\"\n If the log_level of the printer is greater than DEBUG, it prints\n only the message. If it is DEBUG or lower, it shows the message\n along with the traceback of the exception.\n\n :param message: The message to print.\n :param exception: The exception to print.\n :param log_level: The log_level of this message (not used when\n logging the traceback. Tracebacks always have\n a level of DEBUG).\n :param timestamp: The time at which this log occurred. Defaults to\n the current time.\n :param kwargs: Keyword arguments to be passed when logging the\n message (not used when logging the traceback).\n \"\"\"\n if not isinstance(exception, BaseException):\n raise TypeError('log_exception can only log derivatives of '\n 'BaseException.')\n\n traceback_str = '\\n'.join(\n traceback.format_exception(type(exception),\n exception,\n exception.__traceback__))\n\n self.log(log_level, message, timestamp=timestamp, kwargs)\n self.log_message(\n LogMessage(LOG_LEVEL.INFO,\n 'Exception was:' + '\\n' + traceback_str,\n timestamp=timestamp),\n kwargs)\n\n def log_message(self, log_message, kwargs):\n \"\"\"\n It is your reponsibility to implement this method, if you're using this\n mixin.\n \"\"\"\n raise NotImplementedError\n\n\nclass LogPrinter(LogPrinterMixin):\n \"\"\"\n This class is deprecated and will be soon removed. To get logger use\n logging.getLogger(__name__). Make sure that you're getting it when the\n logging configuration is loaded.\n\n The LogPrinter class allows to print log messages to an underlying Printer.\n\n This class is an adapter, means you can create a LogPrinter from every\n existing Printer instance.\n \"\"\"\n\n def __init__(self,\n printer=None,\n log_level=LOG_LEVEL.DEBUG,\n timestamp_format='%X'):\n \"\"\"\n Creates a new log printer from an existing Printer.\n\n :param printer: The underlying Printer where log messages\n shall be written to. If you inherit from\n LogPrinter, set it to self.\n :param log_level: The minimum log level, everything below will\n not be logged.\n :param timestamp_format: The format string for the\n datetime.today().strftime(format) method.\n \"\"\"\n self.logger = logging.getLogger()\n\n self._printer = printer\n self.log_level = log_level\n self.timestamp_format = timestamp_format\n\n @property\n def log_level(self):\n \"\"\"\n Returns current log_level used in logger.\n \"\"\"\n return self.logger.getEffectiveLevel()\n\n @log_level.setter\n def log_level(self, log_level):\n \"\"\"\n Sets log_level for logger.\n \"\"\"\n self.logger.setLevel(log_level)\n\n @property\n def printer(self):\n \"\"\"\n Returns the underlying printer where logs are printed to.\n \"\"\"\n return self._printer\n\n def log_message(self, log_message, kwargs):\n if not isinstance(log_message, LogMessage):\n raise TypeError('log_message should be of type LogMessage.')\n self.logger.log(log_message.log_level, log_message.message)\n\n def __getstate__(self):\n # on Windows there are problems with serializing loggers, so omit it\n oldict = self.__dict__.copy()\n del oldict['logger']\n return oldict\n\n def __setstate__(self, newdict):\n self.__dict__.update(newdict)\n # restore logger by name\n self.logger = logging.getLogger()\n", "path": "coalib/output/printers/LogPrinter.py" } ]	[ { "content": "import traceback\nimport logging\n\nfrom coalib.output.printers.LOG_LEVEL import LOG_LEVEL\nfrom coalib.processes.communication.LogMessage import LogMessage\n\n\nclass LogPrinterMixin:\n \"\"\"\n Provides access to the logging interfaces (e.g. err, warn, info) by routing\n them to the log_message method, which should be implemented by descendants\n of this class.\n \"\"\"\n\n def debug(self, messages, delimiter=' ', timestamp=None, kwargs):\n self.log_message(LogMessage(LOG_LEVEL.DEBUG,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def info(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.INFO,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def warn(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.WARNING,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n *kwargs)\n\n def err(self, messages, delimiter=' ', timestamp=None, *kwargs):\n self.log_message(LogMessage(LOG_LEVEL.ERROR,\n messages,\n delimiter=delimiter,\n timestamp=timestamp),\n kwargs)\n\n def log(self, log_level, message, timestamp=None, kwargs):\n self.log_message(LogMessage(log_level,\n message,\n timestamp=timestamp),\n kwargs)\n\n def log_exception(self,\n message,\n exception,\n log_level=LOG_LEVEL.ERROR,\n timestamp=None,\n kwargs):\n \"\"\"\n If the log_level of the printer is greater than DEBUG, it prints\n only the message. If it is DEBUG or lower, it shows the message\n along with the traceback of the exception.\n\n :param message: The message to print.\n :param exception: The exception to print.\n :param log_level: The log_level of this message (not used when\n logging the traceback. Tracebacks always have\n a level of DEBUG).\n :param timestamp: The time at which this log occurred. Defaults to\n the current time.\n :param kwargs: Keyword arguments to be passed when logging the\n message (not used when logging the traceback).\n \"\"\"\n if not isinstance(exception, BaseException):\n raise TypeError('log_exception can only log derivatives of '\n 'BaseException.')\n\n traceback_str = '\\n'.join(\n traceback.format_exception(type(exception),\n exception,\n exception.__traceback__))\n\n self.log(log_level, message, timestamp=timestamp, kwargs)\n self.log_message(\n LogMessage(LOG_LEVEL.INFO,\n 'Exception was:' + '\\n' + traceback_str,\n timestamp=timestamp),\n kwargs)\n\n def log_message(self, log_message, kwargs):\n \"\"\"\n It is your responsibility to implement this method, if you're using this\n mixin.\n \"\"\"\n raise NotImplementedError\n\n\nclass LogPrinter(LogPrinterMixin):\n \"\"\"\n This class is deprecated and will be soon removed. To get logger use\n logging.getLogger(__name__). Make sure that you're getting it when the\n logging configuration is loaded.\n\n The LogPrinter class allows to print log messages to an underlying Printer.\n\n This class is an adapter, means you can create a LogPrinter from every\n existing Printer instance.\n \"\"\"\n\n def __init__(self,\n printer=None,\n log_level=LOG_LEVEL.DEBUG,\n timestamp_format='%X'):\n \"\"\"\n Creates a new log printer from an existing Printer.\n\n :param printer: The underlying Printer where log messages\n shall be written to. If you inherit from\n LogPrinter, set it to self.\n :param log_level: The minimum log level, everything below will\n not be logged.\n :param timestamp_format: The format string for the\n datetime.today().strftime(format) method.\n \"\"\"\n self.logger = logging.getLogger()\n\n self._printer = printer\n self.log_level = log_level\n self.timestamp_format = timestamp_format\n\n @property\n def log_level(self):\n \"\"\"\n Returns current log_level used in logger.\n \"\"\"\n return self.logger.getEffectiveLevel()\n\n @log_level.setter\n def log_level(self, log_level):\n \"\"\"\n Sets log_level for logger.\n \"\"\"\n self.logger.setLevel(log_level)\n\n @property\n def printer(self):\n \"\"\"\n Returns the underlying printer where logs are printed to.\n \"\"\"\n return self._printer\n\n def log_message(self, log_message, kwargs):\n if not isinstance(log_message, LogMessage):\n raise TypeError('log_message should be of type LogMessage.')\n self.logger.log(log_message.log_level, log_message.message)\n\n def __getstate__(self):\n # on Windows there are problems with serializing loggers, so omit it\n oldict = self.__dict__.copy()\n del oldict['logger']\n return oldict\n\n def __setstate__(self, newdict):\n self.__dict__.update(newdict)\n # restore logger by name\n self.logger = logging.getLogger()\n", "path": "coalib/output/printers/LogPrinter.py" } ]	diff --git a/coalib/output/printers/LogPrinter.py b/coalib/output/printers/LogPrinter.py index 21f3e62495..1e389cbb0d 100644 --- a/coalib/output/printers/LogPrinter.py +++ b/coalib/output/printers/LogPrinter.py @@ -85,7 +85,7 @@ def log_exception(self, def log_message(self, log_message, **kwargs): """ - It is your reponsibility to implement this method, if you're using this + It is your responsibility to implement this method, if you're using this mixin. """ raise NotImplementedError